Rd files

Prof Brian Ripley Prof Brian Ripley <ripley@stats.ox.ac.uk>
Thu, 21 Jan 1999 15:37:49 +0000 (GMT)

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

It's legal with S's files, and it is a great way to avoid file name
problems: just have one file with a simple name (and some of those
in lme and locfit cause problems to several tools: file names with "<" in
are somewhat unexpected!)  However, S has an end of section marker, and
it think that is needed for safety. (In S format, help for one object is
between .BG and .WR.)

Brian D. Ripley,                  ripley@stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272860 (secr)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

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