View source: R/buildVignette.R
buildVignette | R Documentation |
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, ...)
file |
A character string specifying the vignette source file. |
dir |
A character string specifying the working directory. |
latex |
A logical specifying whether a TeX produced by weave should be compiled by texi2pdf or not. |
tangle |
A logical specifying whether tangle should be run or not. |
quiet |
A logical specifying whether weave, texi2pdf, and tangle should be run in quiet mode or not. |
clean |
Remove all files generated by the build, even if there were copies there before. |
engine |
An optional |
buildPkg |
An optional |
... |
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.
Henrik Bengtsson
Since R devel (to become 3.1.0) r63076 (2013-06-27), there is
buildVignette()
in the tools package.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.