rnw(x, file = NULL, ..., raw = FALSE) as.rnw(x, ..., load = TRUE) rnwCompiler(x, verbose = TRUE) rnwWrapper(x, verbose = TRUE) rnwDriver(x) rnwIncludes(x) rnwChildren(x) vignetteMakefile(package = NULL, skip = NULL, print = TRUE, template = NULL, temp = FALSE, checkMode = isCRANcheck(), user = NULL, tests = TRUE) compactVignettes(paths, ...)
rnw
object.as.rnw
that
can be used to force certain building parameters.NULL
, a DESRIPTION
file is looked for one directory up: this meant to work
when building a vignette directly from a package's
'vignettes'
sub-directory.TRUE
),
or simply named vignette.mkTRUE
) or
in development mode, in which case pdflatex
,
bibtex
, and, optionally, qpdf
are
required.checkMode=TRUE
, if the function is called
from within their session.R CMD check
.rnw
provides a unified interface to run vignettes
that detects the type of vignette (Sweave or
knitr
), and which Sweave driver to
use (either automatically or from an embedded command
\VignetteDriver
command).
as.rnw
creates a S3 rnw
object that
contains information about a vignette, e.g., source
filename, driver, fixed included files, etc..
rnwCompiler
tries to detect the vignette compiler
to use on a vignette source file, e.g.,
Sweave
or knitr
.
rnwWrapper
tries to detect the type of vignette
and if it is meant to be wrapped into another main file.
rnwDriver
tries to detect Sweave driver to use on
a vignette source file, e.g., SweaveCache
,
highlight
, etc..
rnwIncludes
detects fixed includes, e.g., image or
pdf files, that are required to build the final document.
rnwChildren
detects included vignette documents
and return them as a list of vignette objects.
vignetteMakefile
returns the path to a generic
makefile used to make vignettes.
Compact PDFs using either gs_quality='none'
or
'ebook'
, depending on which compacts best (as per
CRAN check criteria).