buildVignette

0th

Percentile

Build one vignette

Run Sweave (or other custom weave function) texi2dvi, and/or Stangle (or other custom tangle function) on one vignette.

Keywords
documentation
Usage
buildVignette(file, dir = ".", weave = TRUE, latex = TRUE, tangle = TRUE, quiet = TRUE, clean = TRUE, engine = NULL, buildPkg = NULL, ...)
Arguments
file
character; the vignette source file
dir
character; the working directory in which the intermediate and output files will be produced
weave
logical; should weave be run?
latex
logical; texi2pdf be run if weaving produces a ‘.tex’ file?
tangle
logical; should tangle be run?
quiet
logical; run in quiet mode?
clean
logical; whether to remove intermediate files. See details below.
engine
NULL or character; name of vignette engine to use. Overrides any \VignetteEngine{} markup in the vignette.
buildPkg
NULL or character; an optional package in which to find the vignette engine
...
Additional arguments passed to weave and tangle.
Details

This function determines the vignette engine for the vignette (default utils::Sweave), then weaves and/or tangles the vignette using that engine. Finally, if clean is TRUE, newly created intermediate files will be deleted. If clean is NA, newly created ‘.tex’ files will not be deleted even if a ‘.pdf’ file has been produced from them.

If buildPkg is specified, it will be loaded before the vignette is processed, and will be used as the default package in the search for a vignette engine, but an explicitly specified package in the vignette source (e.g. using \VignetteEngine{utils::Sweave} to specify the Sweave engine in the utils package) will override it. In contrast, if the engine argument is given, it will override the vignette source.

Value

A character vector naming the files that have been produced.

See Also

buildVignettes for building all vignettes in a package.

Aliases
  • buildVignette
Documentation reproduced from package tools, version 3.1.0, License: Part of R 3.1.0

Community examples

Looks like there are no examples yet.