checkVignettes {tools} | R Documentation |
Check all Sweave
files of a package by running
Sweave
and/or Stangle
on them. All
R source code files found after the tangling step are
source
ed to check whether all code can be
executed without errors.
checkVignettes(package, dir, lib.loc = NULL, tangle = TRUE, weave = TRUE, latex = FALSE, workdir = c("tmp", "src", "cur"), keepfiles = FALSE)
package |
a character string naming an installed package. If given, Sweave files are searched in subdirectory ‘doc’. |
dir |
a character string specifying the path to a package's root source directory. This subdirectory ‘inst/doc’ is searched for Sweave files. |
lib.loc |
a character vector of directory names of R libraries,
or NULL . The default value of NULL corresponds to all
libraries currently known. The specified library trees are used to
search for package . |
tangle |
Perform a tangle and source the extracted code? |
weave |
Perform a weave? |
latex |
logical: if weave and latex
are TRUE and there is no ‘Makefile’ in the vignettes
directory, run the weaved files through pdflatex . |
workdir |
Directory used as working directory while checking the
vignettes. If "tmp" then a temporary directory is created,
this is the default. If "src" then the directory containing
the vignettes itself is used, if "cur" then the current
working directory of R is used. |
keepfiles |
Delete files in the temporary directory? This option is
ignored when workdir != "tmp" . |
A ‘vignette’ is a file in the package's ‘inst/doc’ directory with extension ‘.Rnw’ (preferred), ‘.Snw’, ‘.Rtex’ or ‘.Stex’ (and lower-case versions are also accepted).
If tangle
is true, this function runs Stangle
to
produce (one or more) R code files from each vignette, then
source
s each code file in turn.
If weave
is true, the vignettes are run through
Sweave
, which will produce a ‘.tex’ file for each
vignette. If latex
is also true,
texi2dvi(pdf = TRUE)
is run on the ‘.tex’ files
from those vignettes which did not give errors in the previous steps.
An object of class "checkVignettes"
, which is a list with the
error messages found during the tangle, source, weave and latex
steps. There is a print
method for displaying the
information contained in such objects.
Prior to R 2.13.0 this was the code used by R CMD check
,
but the latter is now more careful, running the code for each vignette
in a separate R session.