system_rpt_read_template function

Initialize a New Report

Creates a new officer report based either on the ubiquity template or one specified by the user. Once created, content can then be added.

system_rpt_read_template(
  cfg,
  template = "PowerPoint",
  mapping = NULL,
  rptname = "default"
)

Arguments

• cfg: ubiquity system object
• template: Type of internal template to use ("PowerPoint" or "Word") or path to template file.
• mapping: Path to an onbrand yaml mapping file: If an internal ubiquity template has been supplied, this argument will be ignored and the yaml file from ubiquity will be used.
• rptname: report name

Returns

ubiquity system object with and empty report initialized

Details

The template and mapping inputs can specify either the internal ubiquity templates or user-defined templates If you specify template values of 'PowerPointorWord` then the internal ubiquity templates for PowerPoint or Word will be used and the mapping information will be ignored.

If templates other than the values above are specified you will need also supply a yaml mapping file for an onbrand reporting template. The vignette below highlights how to go about creating these files.

See Also

Reporting vignette (vignette("Reporting", package = "ubiquity"))

Custom Office Template vignette (vignette("Custom_Office_Templates", package="onbrand"))