[R] help page for a function

Uwe Ligges ligges at statistik.uni-dortmund.de
Tue Aug 20 17:37:57 CEST 2002


Erin Hodgess wrote:
> 
> Dear R People
> 
> I have a function that I wrote.  It's not part of a
> library, it's just a nice function.
> 
> However, I would like to have a "Help" page for it.
> How do I go about doing that please?
> 
> Thanks so much in advance!
> 
> R version 1.5.1 for Windows.

There is no clean solution, if you are going to do
 ?my.function
in R, I think.

But you can convert .Rd files to formatted help pages with 
  Rcmd Rdconv ....
if you are going to view the help file by, e.g., double-clicking it.

For help see the R Extension Writers' manual and    Rcmd Rdconv --help .
I'd suggest to build a package -- for sure, some more of your functions
are worth to be commented soon.

Uwe Ligges
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request at stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._



More information about the R-help mailing list