Skip to content

help page for a function

3 messages · Erin Hodgess, Uwe Ligges, Tim Wilson

#
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.

Sincerely,
Erin
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
#
Erin Hodgess wrote:
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
#
On Tue, Aug 20, 2002 at 10:10:13AM -0500, Erin Hodgess wrote:
Check the R manuals at CRAN and look at the "Writing R Extensions"
document. It looks like it will do the trick.

-Tim

--
Henry Sibley HS |  http://www.isd197.org   | http://www.zope.com
W. St. Paul, MN |                          | http://slashdot.org
wilson at visi.com |  <dtml-var pithy_quote>  | http://linux.com
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._