knitr (version 0.6.3)

stitch: Automatically create a report based on an R script and a template

Description

This is a convenience function for small-scale automatic reporting based on an R script and a template.

Usage

stitch(script, template = system.file("misc", "knitr-template.Rnw", package = "knitr"), 
    output = NULL, envir = parent.frame())

Arguments

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 knit); by default it uses the base filename of the script

envir

the environment in which the code chunks are to be evaluated (can use new.env() to guarantee an empty new environment)

Value

• path of the output document

Details

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 chunk named auto-report, which will be used to input all the R code from the script. See the examples below.

See Also

spin (turn a specially formatted R script to a report)

Examples

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"))