[R] Rd: more than one list

[Prof Brian D Ripley]

On Tue, 6 Aug 2002, Christian Hennig wrote:

> Dear group,
>
> I would like to document more than one function on one help page using the
> Rd language. I tried something like
>
> \value{
>   \code{foo1} returns a list with components
>   \item{arg1}{Argument 1}
>   \item{arg2}{Argument 2}
>
>   \code{foo2} returns a list with components
>   \item{arg3}{Argument 3}
>   \item{arg4}{Argument 4}
> }
>
> Unfortunately this makes the text
> "\code{foo2} returns a list with components" disappear in the help pages.
> It seems that, after items are specified, no further text outside of items
> can be processed. Is this true? What can I do to get both value lists
> documented without writing a separate page for foo2?

It is true, for the good reason that one page should describe one function,
or one closely grouped set of functions.  There are workarounds (use the
list markup possibilities) but you should be aware that many of the foramts
to which .Rd can be translated (e.g. Sd, Ssgm) will not work correctly.

Best to accept that the restriction has a good reason.

>
> Best,
> Christian
>
> --
> ***********************************************************************
> Christian Hennig
> Seminar fuer Statistik, ETH-Zentrum (LEO), CH-8092 Zuerich (current)
> and Fachbereich Mathematik-SPST/ZMS, Universitaet Hamburg
> hennig at stat.math.ethz.ch, http://stat.ethz.ch/~hennig/
> hennig at math.uni-hamburg.de, http://www.math.uni-hamburg.de/home/hennig/
> #######################################################################
> ich empfehle www.boag.de
>
>
> -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
> r-help 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-help-request at stat.math.ethz.ch
> _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
>

-- 
Brian D. Ripley,                  ripley at 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-help 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-help-request at stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._