Rd files
Douglas Bates
bates@stat.wisc.edu
21 Jan 1999 09:53:32 -0600
>>>>> "BDR" == Prof Brian Ripley <ripley@stats.ox.ac.uk> writes:
>> From: Paul Gilbert <pgilbert@bank-banque-canada.ca> > From Fritz
>> Leisch
>> >Yes, currently the idea is to have one Rd file per html/help
>> file. I >never thought about it though ... do many people want to
>> be able to >have all documentation in one big file?
>>
>> I don't really care too much about this, I just wanted to make
>> sure I understand
>> it. However, it may not be too difficult allow a large .Rd file
>> and have the build decompose it using the /name{..}. I currently
>> keep many functions in one file along with their documentation
>> separated by /* */. I separate this into the .R and .Rd files
>> with an awk script. So the question for me is whether I have to
>> separate the .Rd file further or is the R build going to do it. I
>> guess I would prefer that the R build do it, as I think others
>> may use it this way too, but I think I can do it fairly easily.
BDR> It's legal with S's files, and it is a great way to avoid file
BDR> name problems: just have one file with a simple name (and some
BDR> of those in lme and locfit cause problems to several tools:
BDR> file names with "<" in are somewhat unexpected!) However, S
BDR> has an end of section marker, and it think that is needed for
BDR> safety. (In S format, help for one object is between .BG and
BDR> .WR.)
The .Rd file name in lme that always gives me trouble is [.pdMat.Rd.
I hadn't realized that the others with "<" in them, like matrix<-.Rd,
also gave problems.
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._