MdReport-class: Buildable markdown report

In datamart: Unified access to your data sources

Description

This class provides the basis for building dynamic reports using markdown text and resource from a datamart. You can create a report with mdreport, which takes a template file name, and a list of variables as arguments. The 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
clss	class of the object, default 'MdReport'
verbose	diagnostic messages T/F
...	number of targets

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.

Value

generic

See Also

mdreport, swvreport

Examples

getSlots("MdReport")

datamart documentation built on May 2, 2019, 9:40 a.m.