R: Builds a vignette

buildVignette {R.rsp} | R Documentation

## Builds a vignette

### Description

Builds a vignette into a PDF or a HTML file.

### Usage

    buildVignette(file, dir=".", latex=TRUE, tangle=TRUE, quiet=TRUE, clean=TRUE,
      engine=NULL, buildPkg=NULL, ...)

### Arguments

`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 `character` string speciyfing 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.
`buildPkg` | 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.

### Value

Returns the filename to the final vignette (PDF or HTML) product. If `latex = FALSE`, it may be a TeX file.

### Author(s)

Henrik Bengtsson

### See Also

Since R devel (to become 3.1.0) r63076 (2013-06-27), there is `buildVignette()` in the tools package.

[Package R.rsp version 0.41.0 Index]