makeSRP {SRPM}R Documentation

Make a Reproducible Research Package

Description

Create a reproducible research package from a Sweave file

Usage

makeSRP(pkg, SweaveFile = NULL, clean = TRUE)
makeWebpage(clear = FALSE)

Arguments

pkg name of the package to be created
SweaveFile name of the Sweave file
clean logical, delete any files created in the package generation process?
clear logical, should the directory in which the webpages will be written be removed if it already exists?

Details

makeSRP reads the data map file created by the cacheSweave package and uses the information to generate a "reproducible research package" (RRP). Any cached computation databases are copied into the package as well as any figures and the article itself. The figures and the article should be in PDF format.

After creating a reproducible research package with makeSRP, one can register the package with setPackage and use the makeWebpage function to construct a rudimentary web interface to the package. makeWebpage places the HTML files in a directory called "html" under the main directory of the reproducible research package.

If SweaveFile is NULL then it defaults to using <pkg>.Rnw.

Value

A list of objects of class codeObject corresponding to the code chunks in the Sweave file is returned (invisibly).

Author(s)

Roger D. Peng rpeng@jhsph.edu


[Package SRPM version 0.1-5 Index]