Set or Get a Vignette Processing Engine
Vignettes are normally processed by
Sweave, but package
writers may choose to use a different engine (e.g., one provided by the
knitr, noweb or R.rsp packages). This function
is used by those packages to register their engines, and internally by
R to retrieve them.
the name of the engine.
a function to convert vignette source files to LaTeX output.
a function to convert vignette source files to R code.
a regular expression pattern for the filenames handled
by this engine, or
the package registering the engine. By default, this
is the package calling
a list with element names
weave is missing,
vignetteEngine will return the currently
registered engine matching
NULL, the specified engine will be deleted.
Other settings define a new engine. The
functions must be defined with argument lists compatible with
function(file, ...). Currently the
... arguments may
include logical argument
quiet and character argument
encoding; others may be added in future. These are described in
the documentation for
tangle functions should return the
filename of the output file that has been produced. Currently the
weave function, when operating on a file named ‘<name>
<pattern>’ must produce a file named ‘<name>[.](tex|pdf|html)’.
The ‘.tex’ files will be processed by
produce ‘.pdf’ output for display to the user; the others will be
displayed as produced. The
tangle function must produce a file
named ‘<name>[.][rRsS]’ containing the executable R code from
the vignette. The
tangle function may support a
TRUE argument, and then it should produce files named
pattern argument gives a regular expression to match the
extensions of files which are to be processed as vignette input files.
If set to
NULL, the default pattern
If the engine is being deleted,
NULL. Otherwise a list
The name of the engine
The name of its package
The pattern for vignette input files
The weave function
The tangle function
Duncan Murdoch and Henrik Bengtsson.
Sweave and the ‘Writing R Extensions’ manual.
Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.