[R] Documenting options specific to a package.

2007-02-19 Thread rolf
If one specifies new options in a package, using the options() function, where does/should one document these new options? E.g. suppose that I put the line options(melvin=42) in a file zzz.R in the R directory of the package source, where the package contains functions foo(), bar(),

Re: [R] Documenting options specific to a package.

2007-02-19 Thread Prof Brian Ripley
(An R-devel topic, I believe.) I would have documentation for options() in the package that documented the additional options and linked to \code{\link[base]{options}}. Users will be given a choice of which page to view on most systems, so just make sure the title makes clear that this is