[R] Rd installation (not markup language) primer?

Duncan Murdoch murdoch.duncan at gmail.com
Wed Nov 3 23:35:59 CET 2010

On 03/11/2010 6:28 PM, ivo welch wrote:
> I have a set of functions that I always load on startup.  for example,
> there is my now infamous "is.defined()" function.
> I would like to add some documentation for these functions, so that I can do a
>     ?is.defined
> inside R.  The documentation tells me how to mark up Rd files is very
> good, but I wonder how one installs them for access by the R
> executable (on OSX for me).  Do I drop them into a special directory?
> Which ones are allowed?  Do I need to package everything into a
> library, or can I just add Rd files for source'd files?  Do I parse
> the Rd files for R, or does R parse the Rd files on demand?
> so, is there a primer on installing Rd files?

Writing R Extensions is the main documentation.  You put them in the man 
directory of a package, and R does the rest when you install the package.

Duncan Murdoch

> /iaw
> ----
> Ivo Welch (ivo.welch at brown.edu, ivo.welch at gmail.com)
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.

More information about the R-help mailing list