stitch {knitr} | R Documentation |
This is a convenience function for small-scale automatic reporting based on
an R script and a template. The default template is an Rnw file (LaTeX);
stitch_rhtml()
and stitch_rmd()
are wrappers on top of
stitch()
using the R HTML and R Markdown templates respectively.
stitch(script, template = system.file("misc", "knitr-template.Rnw", package = "knitr"), output = NULL, text = NULL, envir = parent.frame()) stitch_rhtml(..., envir = parent.frame()) stitch_rmd(..., envir = parent.frame())
script |
path to the R script |
template |
path of the template to use (by default the Rnw template in this package; there is also an HTML template in knitr) |
output |
the output filename (passed to |
text |
a character vector as an alternative way to provide the input file |
envir |
the environment in which the code chunks are to be evaluated
(for example, |
... |
arguments passed to |
The first two lines of the R script can contain the title and author of the report in comments of the form ## title: and ## author:. The template must have a token %sCHUNK_LABEL_HERE, which will be used to input all the R code from the script. See the examples below.
The R script may contain chunk headers of the form ## ---- label, opt1=val1, opt2=val2, which will be copied to the template; if no chunk headers are found, the whole R script will be inserted into the template as one code chunk.
path of the output document
spin
(turn a specially formatted R script to a report)
s = system.file("misc", "stitch-test.R", package = "knitr") if (interactive()) stitch(s) # compile to PDF # HTML report stitch(s, system.file("misc", "knitr-template.Rhtml", package = "knitr")) # or convert markdown to HTML stitch(s, system.file("misc", "knitr-template.Rmd", package = "knitr"))