Rd files

Paul Gilbert pgilbert@bank-banque-canada.ca
Wed, 20 Jan 1999 15:46:40 -0500


I've just been looking at the possibility of converting my html help to Rd
files. Could you please remind me of a few things (or point me to where they are

- Must there be separate .Rd files for each function or can they be combined
into one large file?

- Is the name{..} field used or is the name field picked up from the file name?
(Looking at the html result of a few tests it seems to be picked up from the
file name, but then what does name{..} do?

- Does this work in file systems with more restrictive (e.g.. 8.3) file names?
If so, how do I specify the function names?

- Is there a fixed set of legitimate headings or can I add things easily?

- Is there a fixed set of legitimate keywords or can I add anything?

- What was once called "details" in the S documentation appears to be called
"description" in the Rd files and what was called description (but was often
just about the same as the title) is gone in the Rd files. Is that right?

- R INSTALL  does not seem to report errors in Rd files that I know have syntax
problems. Is there a way to get error reports?


r-devel 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-devel-request@stat.math.ethz.ch