[R] function help?

[Rolf Turner]

On 17/09/2010, at 8:51 AM, Duke wrote:

>  Hi Duncan,
> 
> On 9/16/10 3:47 PM, Duncan Murdoch wrote:
>> On 16/09/2010 3:40 PM, Duke wrote:
>>>   Hi all,
>>> 
>>> I am writing a function (fun.R), but I dont know how to code the
>>> function so that the Help Text will be shown up when one types ?fun (of
>>> course, after he loads it up). Anyone has any advice for me how to do 
>>> that?
>>> 
>>> 
>> 
>> The help text is separate from the function (unless you use the 
>> roxygen package or similar).  You need to write a package so that R 
>> will find the help; instructions are in the Writing R Extensions manual.
> 
> I was expecting something simpler than writing a package, and that I can 
> integrate it into fun.R, but thanks anyway.

(a) Writing a package is not all that hard.

(b) It focuses the mind wondrously.

(c) Using R CMD check on the package is very useful for picking the
lint off the code.

	cheers,

		Rolf Turner

######################################################################
Attention:\ This e-mail message is privileged and confid...{{dropped:9}}