buildVignettes {tools}R Documentation

List and Build Package Vignettes

Description

Run Sweave (or other custom weave function) and texi2dvi on all vignettes of a package.

Usage

buildVignettes(package, dir, lib.loc = NULL, quiet = TRUE,
               clean = TRUE, tangle = FALSE)

pkgVignettes(package, dir, subdirs = NULL, lib.loc = NULL,
	     output = FALSE, source = FALSE)

Arguments

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 ‘vignettes’ (or if it does not exist ‘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.

quiet

logical. Weave and run texi2pdf in quiet mode.

clean

Remove all files generated by the build, even if there were copies there before.

tangle

logical. Do tangling as well as weaving.

subdirs

a character vector of subdirectories of dir in which to look for vignettes. Ignored if package is used.

output

logical. If TRUE, the output filename for each vignette in the result.

source

logical. If TRUE, include the tangled output filename for each vignette in the result.

Details

buildVignettes is used by R CMD build and R CMD check to (re-)build vignette PDFs from their (typically Sweave) sources.

Value

buildVignettes is called for its side effect of creating the PDF versions 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.


[Package tools version 3.0.1 Index]