weaver {weaver} | R Documentation |
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.
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)
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. |
weaver
supports the following options for code chunks (the values
in parentheses show the default values):
TRUE
). Include S code in the
output file?TRUE
). If FALSE
, the code chunk is not
evaluated, and hence no text or graphical output produced.FALSE
). When echoing, if keep.source ==
TRUE
the original source is copied to the file. Otherwise,
deparsed source is echoed.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).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.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.FALSE
). If TRUE
, text output is
written to separate files
for each code chunk.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.TRUE
). If TRUE
generated filenames of
figures and output have a common prefix.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).FALSE
), indicating whether the code
chunk produces
graphical output. Note that only one figure per code chunk can be
processed this way.TRUE
), indicating whether EPS figures shall be
generated. Ignored if fig = FALSE
.TRUE
), indicating whether PDF figures shall be
generated. Ignored if fig = FALSE
.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.Seth Falcon (borrowing heavily from code by Friedrich Leisch)
Friedrich Leisch: Sweave User Manual, 2002
http://www.ci.tuwien.ac.at/~leisch/Sweave
## Not run: Sweave("yourfile.Rnw", driver=weaver()) ## End(Not run)