buildVignette.Rd
Builds a vignette into a PDF or a HTML file.
buildVignette(file, dir=".", latex=TRUE, tangle=TRUE, quiet=TRUE, clean=TRUE,
engine=NULL, buildPkg=NULL, ...)
A character string specifying the vignette source file.
A character string specifying the working directory.
A logical specifying whether a TeX produced by weave should be compiled by texi2pdf or not.
A logical specifying whether tangle should be run or not.
A logical specifying whether weave, texi2pdf, and tangle should be run in quiet mode or not.
Remove all files generated by the build, even if there were copies there before.
An optional character
string specifying the vignette
engine to use for building the vignette. If not specified, it will
be inferred from the \VignetteEngine{}
markup in the
vignette. If that is not specified, the "utils::Sweave"
engine will be used.
An optional character
string specifying the vignette
package to use, if the vignette engine does not specify one.
Additional arguments passed to weave and tangle.
Returns the filename to the final vignette (PDF or HTML) product.
If latex = FALSE
, it may be a TeX file.
Since R devel (to become 3.1.0) r63076 (2013-06-27), there is
buildVignette()
in the tools package.