[Rd] Where to put package vignettes
sorenh at math.aau.dk
Thu Feb 20 12:48:19 CET 2014
My understanding is this:
1) Put vignettes files (.Rnw files) in the /vignettes subdirectory. 2) Build the package foo with R CMD build foo. 3) Install the package with R CMD INSTALL foo_xxx.tar.gz
Then the vignettes will be available. However you can also install the package with R CMD INSTALL foo, but then the vignettes will *not* be available (because it is in the build process that the vignettes go from /vignettes to /inst/doc)
From: r-devel-bounces at r-project.org [mailto:r-devel-bounces at r-project.org] On Behalf Of Guillermo.Vinue at uv.es
Sent: 20. februar 2014 12:19
To: r-devel at r-project.org
Subject: [Rd] Where to put package vignettes
Dear R-devel list,
My name is Guillermo Vinué. I have created an R package that includes a vignette. Earlier on, to test my package, I tried to install it both in Linux and Windows and it worked. My vignette was in /inst/doc.
Now, I have finished for good and before submitting my package to CRAN I've tried to install it again first in Linux and then in Windows (I removed that first installation some time ago).
My package was succesfully installed in Linux (Fedora 18 and R 2.15.2) and the vignette was available. However, when trying to install it in Windows (R 3.0.2), unfortunately the vignette didn't appear. My vignette is build with knitr.
In fact, if I first install the package on Windows, the vignette is accesible, but then in Linux, not.
I have read that as from R 2.14.0 the preferred location for the Sweave sources is the subdirectory vignettes of the source packages, but for compatibility with earlier versions of R, vignette sources will be looked for in inst/doc if vignettes does not exist.
Where do I have to put my vignette so that it could be available with any installation and which files (.Rnw or .pdf) should be included?.
I hope you can clarify my doubts. I have seen the collection of prior postings to the list, but I have not found a specifical answer to my doubts .
Thank you very much in advance.
R-devel at r-project.org mailing list
More information about the R-devel