[R] *.Rd: line breaks incorrect (?) \examples

[Prof Brian Ripley]

On Mon, 13 Sep 2004, Christian Hoffmann wrote:

> Hi all,
> 
> I am using
> 
> R, Version 1.9.1 alpha (2004-05-25), ISBN 3-900051-00-3

Oh, please use a released version or 2.0.0 alpha.

[...]

> In the guide to writing packages I did not find warnings concerning the 
> following:
> 
> - long lines in \examples{} and \author{} are not folded (broken) in the 

\examples is *verbatim* as it says.

I don't think this is correct about \author.

> resulting *.ps.
> 
> - If I want to write a comment in \examples{} using #, like:
>    \examples{
>    executable stuff  # comment   \emph{}  \code{\link{}}
>    }
>    then \emph{} and \code{\link{}} are transformed into a queer sequence 
> of characters.   Question: where are \emph{}  \code{\link{}} allowed?

Outside *verbatim* environments.

> - More general: Where are TeX constructs allowed? $x_{nn}
> - Where are TeX constructs mandatory?

Inside the first argument of \eqn and \deqn only.

> - Why are pck.Rcheck/pck-manual.aux, .dvi, and .log generated by runnung 
> R CMD build etc., but not pck.Rcheck/pck-manual.ps?    However, 

They are not.  They *are* generated by R CMD check, as that checks the 
latex help files.  If you want a .ps manual for a package use R CMD RD2dvi
and then run the appropriate dvi-to-ps command on your system (R does not 
know about such commands).

> pck.Rcheck/pck-Examples *is* generated.

Well, the examples are run.

-- 
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 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595