Automatically create a report based on an R script and a template
This is a convenience function for small-scale automatic reporting based on an R script and a template.
stitch(script, template = system.file("misc", "knitr-template.Rnw", package = "knitr"), output = NULL, envir = parent.frame())
- path to the R script
- path of the template to use (by default
the Rnw template in this package; there is also an HTML
- the output filename (passed to
knit); by default it uses the base filename of the script
- the environment in which the code chunks are
to be evaluated (can use
new.env()to guarantee an empty new environment)
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 ## @knitr label, 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") stitch(s) # 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"))