Re: [R] Package docs for CRAN

From: Gabor Grothendieck <ggrothendieck_at_gmail.com>
Date: Mon 01 May 2006 - 00:11:52 EST

If your package is called mypkg you could create a mypkg-package.Rd file. e.g.

library(dyn)
library(help = dyn) # note that mypkg-package is listed package?dyn
?"dyn-package" # same

and you could add one or more vignettes, e.g.

library(zoo)
library(help = zoo) # note that the 2 vignettes are listed at end vignette("zoo")

On 4/30/06, William Asquith <wasquith@austin.rr.com> wrote:
> CRAN et al.,
>
> I would like to add an extented introduction or other arbitrary
> sections to my package lmomco.
> I have been shipping inst/doc/Introduction.Rd. I would like to have
> this content inserted to the front of the PDF build for the CRAN. The
> R-exts.pdf seems to be a little silent on this subject? For my
> purposes, I have been doing this
>
> R CMD Rd2dvi --pdf --title="lmomco---version X" inst/doc/
> Introduction.Rd man/*.Rd
>
> but I don't get the correct header (description) or the index built
> as seen in the lmomco.pdf from the CRAN.
>
> Further, is there any point in shipping a complete PDF build of the
> docs as in inst/doc/lmomco.pdf?
>
> Please advise on best practices for building the best docs that I
> can. . .
>
> William
>
> ______________________________________________
> R-help@stat.math.ethz.ch mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide! http://www.R-project.org/posting-guide.html
>



R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide! http://www.R-project.org/posting-guide.html Received on Mon May 01 00:21:28 2006

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.1.8, at Mon 01 May 2006 - 02:09:54 EST.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-help. Please read the posting guide before posting to the list.