| buildVignettes | R Documentation |
Run Sweave (or other custom weave function)
and texi2pdf on all vignettes
of a package, or list the vignettes.
buildVignettes(package, dir, lib.loc = NULL, quiet = TRUE,
clean = TRUE, tangle = FALSE, ser_elibs = NULL)
pkgVignettes(package, dir, subdirs = NULL, lib.loc = NULL,
output = FALSE, source = FALSE, check = FALSE)
package |
a character string naming an installed package. If given, vignette source files are by default looked for in subdirectory ‘doc’. |
dir |
a character string specifying the path to a package's root source directory. If given, vignette source files are by default looked for in subdirectory ‘vignettes’. |
lib.loc |
a character vector of directory names of R libraries,
or |
quiet |
logical.
Weave and run |
clean |
Remove all files generated by the build, even if there were copies there before. |
tangle |
logical. Do tangling as well as weaving. |
ser_elibs |
For use from |
subdirs |
a character vector of subdirectories of |
output |
logical indicating if the output filenames for each
vignette should be returned (in component |
source |
logical indicating if the tangled output
filenames for each vignette should be returned (in component |
check |
logical. If |
buildVignettes is used by R CMD build and
R CMD check to (re-)build vignette outputs from their sources.
As from R 3.4.1, both of these functions ignore files that are listed in
the ‘.Rbuildignore’ file in dir.
buildVignettes is called for its side effect of creating the
outputs of all vignettes, and if tangle = TRUE,
extracting the R code.
pkgVignettes returns an object of class "pkgVignettes"
if a vignette directory is found, otherwise NULL.
gVigns <- pkgVignettes("grid")
str(gVigns)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.
