MdReport-class: Buildable report
Description
The main S4 class in this framework is MdReport.
You can create a report with mdreport, which takes
a template file name, and a list of variables as
arguments. The new generic method put. can then be
used to actually produce the report at various locations
(directory, memory, blogging site).
see class MdReport for details.Usage
mdreport(tpl, name = "", xdata = NULL, clss = "MdReport",
verbose = getOption("verbose"), ...)Arguments
tpl
path to markdown template file
name
name of the Report, default ''
xdata
instance of Xdata class
verbose
diagnostic messages T/F
clss
class of the object, default 'MdReport'
Details
strsubst is a simple templating mechanism inspired
from Python (PEP-0292). Variables in the template are
marked by a preceeding dollar sign and get replaced with
the value of the corresponding variables passed to
strsubst.