Skip to content

--as-cran / BuildVignettes: false

3 messages · Paul Gilbert, Uwe Ligges, Claudia Beleites

Original
Paul Gilbert
# 
I have packages where I know CRAN and other test platforms do not have 
all the resources to build the vignettes, for example, access to 
databases. Previously I think putting

  BuildVignettes: false

in the DESCRIPTION file resolved this, by preventing CRAN checks from 
attempting to run the vignette code. (If it was not this, then there was 
some other magic I don't understand.)

Now, when I specify --as-cran, the checks fail when attempting to check 
R code from vignettes, even though I have "BuildVignettes: false" in the 
DESCRIPTION file.

What is the mechanism for indicating that CRAN should not attempt to 
check this code?  Perhaps it is intentionally difficult - I can see an 
argument for that.  (For running tests there are environment variables, 
e.g._R_CHECK_HAVE_MYSQL_, but using these really clutters up a vignette, 
and it did not seem necessary to use them before.)

(The difficult also occurs on R-forge, possibly because it is using 
--as-cran like settings.)

Paul
Uwe Ligges
#
On 28.03.2012 18:07, Paul Gilbert wrote:
Paul, it says "BuiltVignettes" rather than "CheckVignettes".
If you want CRAN to disable those checks for some very good reason, 
please tell the CRAN maintainers, they will move your package to the 
exclude list for vignette checking.

Best,
Uwe
1 day later
Claudia Beleites
# 
Paul,
For some of my vignettes that is true, too. For those, the vignette
directory contains the .pdf produced on my machine and a "fake" .Rnw,
which contains only the \Vignette*{} entries needed to get the vignette
listed properly and an additional comment pointing users to the package
homepage at r-forge where the real .Rnw and the raw data files are
available.
To prevent the fake .Rnw producing an empty pdf that overwrites the one
I provide, I use a Makefile - learnt that from one of Dirk Eddelb?ttel's
packages (forget which, but thanks, Dirk!)

Claudia