[R] Package manuals.

Prof Brian Ripley ripley at stats.ox.ac.uk
Tue Feb 3 08:23:40 CET 2009


If I do this on the top-level directry of a package, I get

tystie% R CMD Rd2dvi --pdf RODBC
Hmm ... looks like a package
...

and it does so by looking for a 'foo/DESCRIPTION' file, and it does 
give an index.

I think you probably do need to update your R, as in < 2.8.1 if there 
was a problem with latex-ing, it gave no indication and no index.

I believe CRAN uses the manual produced by R CMD check, which uses 
pkg2tex.pl if there is a latex directory in the built package.

On Tue, 3 Feb 2009, Rolf Turner wrote:

>
> When I create a manual for a package that I create and use locally,
> e.g. via
>
> 	R CMD Rd2dvi --pdf foo
>
> where ``foo'' is the name of the directory containing the source for
> the package (also named ``foo'') the resulting manual does not appear
> to have an index.
>
> The package.pdf files appearing on CRAN all seem to have indices.  What must
> I do to get an index appended to the package?  Is there some modification
> needed to the ``R CMD Rd2dvi'' incantation, or do I need to proceed in
> a different manner entirely?  I looked for an answer in ``Writing R 
> Extensions''
> but could not see one.
>
> I also notice an unimportant but mysterious difference in the manual titles.
> The manuals I produce locally (via R CMD Rd2dvi --pdf foo) have titles of
> the form `` Package `foo' ''.  Those on CRAN seem to have titles of the
> from `` The foo Package''.  What induces this difference?
>
> 	cheers,
>
> 		Rolf Turner
>
> P. S.: In case it's of any consequence, my session info is:
>
> R version 2.8.0 (2008-10-20)
> i386-apple-darwin8.11.1
>
> locale:
> C
>
> attached base packages:
> [1] datasets  utils     stats     graphics  grDevices methods   base
>
> other attached packages:
> [1] misc_0.0-11    fortunes_1.3-5 MASS_7.2-44
>
>
> ######################################################################
> Attention:\ This e-mail message is privileged and confid...{{dropped:9}}
>
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.

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



More information about the R-help mailing list