On 11.04.2012 23:28, Yihui Xie wrote:
For 1, you should run R CMD check on the tar ball (pkg_x.x.tar.gz)
from R CMD build instead of the source directory. R CMD build will
build the PDF vignette into the tar ball.
Just move vignette sources to :/vignettes in your package?
Uwe
For 2, I have been confused by ./vignettes vs ./inst/doc since
./vignettes was introduced. I might be able to figure it out by
try-and-err but I never tried, and I'm still sticking to ./inst/doc.
At least you can exclude the Rnw source in .Rbuildignore so that R can
only stare at your PDF documents and sigh.
For 3, I remember some of us requested that R could also respect
entries of non-Sweave vignettes (like the ones in ./demo/00Index), but
this is not possible as far as I know. However, I can tell you a dark
voodoo seems to be still working: you can write your own index.html
under ./inst/doc with your own links to vignettes.
Regards,
Yihui
--
Yihui Xie<xieyi...@gmail.com>
Phone: 515-294-2465 Web: http://yihui.name
Department of Statistics, Iowa State University
2215 Snedecor Hall, Ames, IA
On Wed, Apr 11, 2012 at 3:41 PM, Terry Therneau<thern...@mayo.edu> wrote:
Context: R2.15-0 on Ubuntu.
1. I get a WARNING from CMD check for "Package vignette(s) without
corresponding PDF:
In this case the vignettes directory had both the pdf and Rnw; do I need to
move the pdf to inst/doc?
I'm reluctant to add the pdf to the svn source on Rforge, per the usual
rule that a code management system should not have both a primary source and
a object dervived from it under version control. However, if this is the
suggested norm I could do so.
2. Close reading of the paragraph about vignette sources shows the following
-- I think? If I have a vignette that should not be rebuilt by "check" or
"BUILD" I should put the .Rnw source and pdf in /inst/doc, and have the
others that should be rebuilt in /vignettes. This would include any that
use "private R packages, screen snapshots, ...", or in my case one that
takes just a little short of forever to run.
3. Do these unprocessed package also contribute to the index via
\VignetteIndexEntry lines, or will I need to create a custom index?
Terry Therneau
______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
