Hi Tobias, The .R files that I have created for all my functions are somehow used to generate a package manual pdf when I used R CMD CHECK. This is what I'd like to add in my vignette. It might be uncommon, but I saw this was done for several package documentations (e.g. PBS collections) and I kind of like this combination.
Sebastien On Wed, Apr 14, 2010 at 6:52 AM, Tobias Verbeke < tobias.verb...@openanalytics.eu> wrote: > Hi Sébastien, > > > Sébastien Bihorel wrote: > > I am currently writing the documentation for my first package. I have >> created a short user manual using sweave/pdflatex which is distinct from >> the >> manual/summary-of-package-functions created by R CMD CHECK. I was >> wondering >> how could I seamlessly combine both documents. >> > > It is common to have > - technical documentation in your .Rd files (in the man/ directory > of your package) > - functional documentation as a so-called vignette (Sweave file > documenting concrete use of your package) in the > inst/doc directory of your package. > > http://cran.r-project.org/doc/manuals/R-exts.html#Writing-package-vignettes > > Combining both documents into one file is not common. > > I hope this helps, > Tobias > > [[alternative HTML version deleted]]
______________________________________________ R-help@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.
