From Kurt.Hornik@ci.tuwien.ac.at  Sun Apr 30 16:40:26 2000
From: Kurt.Hornik@ci.tuwien.ac.at (Kurt Hornik)
Date: Sun, 30 Apr 2000 17:40:26 +0200 (CEST)
Subject: [Rd] Rd files with multiple functions?
In-Reply-To: <3909CD1D.25E3A964@bank-banque-canada.ca>
References: <200004281657.RAA01123@toucan.stats.ox.ac.uk>
 <3909CD1D.25E3A964@bank-banque-canada.ca>
Message-ID: <14604.21482.220633.89296@aragorn.ci.tuwien.ac.at>

>>>>> Paul Gilbert writes:

> 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?

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


[Rd] Rd files with multiple functions?
Kurt Hornik