odfWeave {odfWeave} | R Documentation |
Sweave processing of Open Document Format files
odfWeave(file, dest, workDir = odfTmpDir(), control = odfWeaveControl())
file |
the ODF file created using OpenOffice V2.0 or above. |
dest |
path to put the processed file (should include file name and extension) |
workDir |
a path to a directory where the source file will be unpacked and processed |
control |
a list of control settings. See
odfWeaveControl
for the names of the settable control values and their effects. |
odfWeave
can be used to embed R code within a word processing
document. The odfWeave
package was created so that the
functionality
of Sweave
can used to generate documents
that the end–user can easily edit.
The markup language used is the Open Document Format (ODF), which is an
open, non–proprietary format that encompasses text documents,
presentations and spreadsheets. There are several editors/office suites
that can produce ODF files. OpenOffice, as of version 2.0, uses ODF as
the default format. odfWeave
has been tested with OpenOffice to produce text documents. As of the
current version, odfWeave
processing of presentations and
spreadsheets should be considered to be experimental (but should be
supported in subsequent versions).
Since ODF files are compressed archives of files and directories, R
will need to zip and unzip the source file. While R has an unzip
utility, it does not have one for re-zipping files, so an external
application is needed. unzip
and zip
are free utilities located at
Also, jar
can be used. See link{odfWeaveControl}
for more
information on configuring odfWeave
to use applications other than
zip
and unzip
.
The functionality of Sweave
is mostly preserved in
odfWeave
, such as weaving, hooks, figure environments, etc. Some
functionality, such as writing output to separate files for each code
chunk using the split
argument, doesn't make sense when using
ODF. See RweaveOdf
for more details about the available
options.
odfWeave
uses the noweb convention for R code. In-line R commands
should be in \Sexpr
calls and block code chunks should use the
<<>>=
syntax (i.e. no Latex syntax will currently work).
The image format and sizes are specified using setImageDefs
.
The dimensions of the image file and the dimensions of the rendered
image can be set independently. See setImageDefs
for more details.
an ODF file with the R output
Max Kuhn
odfWeaveControl
, RweaveOdf
, Sweave
## Not run: vignette("odfWeave") ## Not run: demoFile <- system.file("examples", "examples.odt", package = "odfWeave") demoFile <- system.file("examples", "testCases.odt", package = "odfWeave") ## End(Not run) demoFile <- system.file("examples", "simple.odt", package = "odfWeave") outputFile <- gsub("simple.odt", "output.odt", demoFile) library(odfWeave) odfWeave(demoFile, outputFile)