weaver: A modified R/LaTeX Driver for Sweave

In weaver: Tools and extensions for processing Sweave documents

Description

A modified driver for Sweave that translates R code chunks in LaTeX files. Presently, the primary modification is that this version provides chunk caching. In the chunk options, you can specify cache=TRUE and the results of that chunk will be cached.

Usage

weaver()

weaverLatexSetup(file, syntax, output = NULL, quiet = FALSE, debug = FALSE, echo = TRUE, eval = TRUE, keep.source = FALSE, split = FALSE, stylepath = TRUE, pdf = TRUE, eps = TRUE, use.cache = TRUE)

Arguments

file	Name of Sweave source file.
syntax	An object of class SweaveSyntax.
output	Name of output file, default is to remove extension ‘.nw’, ‘.Rnw’ or ‘.Snw’ and to add extension ‘.tex’. Any directory names in file are also removed such that the output is created in the current working directory.
quiet	If TRUE all progress messages are suppressed.
debug	If TRUE, input and output of all code chunks is copied to the console.
stylepath	If TRUE, a hard path to the file ‘Sweave.sty’ installed with this package is set, if FALSE, only \usepackage{Sweave} is written. The hard path makes the TeX file less portable, but avoids the problem of installing the current version of ‘Sweave.sty’ to some place in your TeX input path. The argument is ignored if a \usepackage{Sweave} is already present in the Sweave source file.
echo	set default for option echo, see details below.
eval	set default for option eval, see details below.
keep.source	set default for option 'keep.source', see details below.
split	set default for option split, see details below.
pdf	set default for option pdf, see details below.
eps	set default for option eps, see details below.
use.cache	a logical indicating whether or not to use the caching system. If FALSE, no caching is performed and all code chunks are recomputed.

Supported Options

weaver supports the following options for code chunks (the values in parentheses show the default values):

echo:

logical (TRUE). Include S code in the output file?

eval:

logical (TRUE). If FALSE, the code chunk is not evaluated, and hence no text or graphical output produced.

keep.source:

logical (FALSE). When echoing, if keep.source == TRUE the original source is copied to the file. Otherwise, deparsed source is echoed.

results:

character string (verbatim). If verbatim, the output of S commands is included in the verbatim-like Soutput environment. If tex, the output is taken to be already proper latex markup and included as is. If hide then all output is completely suppressed (but the code executed during the weave).

print:

logical (FALSE) If TRUE, each expression in the code chunk is wrapped into a print() statement before evaluation, such that the values of all expressions become visible.

term:

logical (TRUE). If TRUE, visibility of values emulates an interactive R session: values of assignments are not printed, values of single objects are printed. If FALSE, output comes only from explicit print or cat statements.

split:

logical (FALSE). If TRUE, text output is written to separate files for each code chunk.

strip.white:

character string (false). If true, blank lines at the beginning and end of output are removed. If all, then all blank lines are removed from the output.

prefix:

logical (TRUE). If TRUE generated filenames of figures and output have a common prefix.

prefix.string:

a character string, default is the name of the ‘.Snw’ source file.

include:

logical (TRUE), indicating whether input statements for text output and includegraphics statements for figures should be auto-generated. Use include = FALSE if the output should appear in a different place than the code chunk (by placing the input line manually).

fig:

logical (FALSE), indicating whether the code chunk produces graphical output. Note that only one figure per code chunk can be processed this way.

eps:

logical (TRUE), indicating whether EPS figures shall be generated. Ignored if fig = FALSE.

pdf:

logical (TRUE), indicating whether PDF figures shall be generated. Ignored if fig = FALSE.

width:

numeric (6), width of figures in inch.

height:

numeric (6), height of figures in inch.

cache

If TRUE and weave was called with use.cache=TRUE, then the caclulations in the code chunk will be cached. Subsequent invocations will restore from the cache if the code chunk has not changed. Side effects are not captured. Do not use for chunks defining S4 classes or methods.

Author(s)

Seth Falcon (borrowing heavily from code by Friedrich Leisch)

References

Friedrich Leisch: Sweave User Manual, 2002
http://www.ci.tuwien.ac.at/~leisch/Sweave

See Also

Sweave, Rtangle

Examples

## Not run: 
  Sweave("yourfile.Rnw", driver=weaver())

## End(Not run)

weaver documentation built on Nov. 8, 2020, 5:05 p.m.