Skip to content

Rd files with multiple functions?

3 messages · Brian Ripley, Paul Gilbert, Kurt Hornik

#
<bates@stat.wisc.edu>
..).
so
No, the \name is the name of the *file*, the \alias'es are the names
of the objects.

Use \name for a topic, that is the package name in your example. See
e.g. Poisson.Rd that has \name{Poisson}, but there is no function
Poisson(), and the functions are named as \alias{}es
#
I guess I'm using the wrong terminology, and also getting confused because \name
seems to mean both "topic" and "file".

Let me ask the broader question. What I would like to do is keep all my
documentation for a package in one file because this makes searching and editing
simpler (in the same way that I keep all the code in one .R file). I still end
up with a fairly large number of files since there are many packages involved,
but it's only a dozen or so, not hundreds. What I have been doing is keeping it
this way and then using a script to parse the file into multiple .Rd files which
I put in the man directory. Each of these files is a topic and has one \name
line. My question is: Is it still necessary for me to parse the file, or is that
being supported by R now?

Thanks,
Paul Gilbert

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
1 day later
#
It is not supported.

Re terminology. `topic' is really anything that documentation is given
for (such as an R object, a concept, etc ...).  That's also why the
argument in help() is called `topic'.  One declares the topics a file
(documentation object) provides documentation for using the \alias
statements (which maybe should be called \topic then ...)

(So, `each of these files is a topic' may be misleading ...)

-k
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._