Skip to contents

Generate Report Previewing the Locations From Mapping File

Source: R/preview_template.R
preview_template.Rd

Takes an onbrand object with a loaded template and populates the template with the elements from the mapping file.

Usage

preview_template(obnd, verbose = TRUE)

Arguments

obnd

onbrand report object

verbose

Boolean variable when set to TRUE (default) messages will be displayed on the terminal; Messages will be included in the returned onbrand object.

Value

onbrand object with template previews added and any messages passed along

Examples

obnd = read_template(
   template = file.path(system.file(package="onbrand"), "templates", "report.pptx"),
   mapping  = file.path(system.file(package="onbrand"), "templates", "report.yaml"))
obnd = preview_template(obnd)

obnd = read_template(
   template = file.path(system.file(package="onbrand"), "templates", "report.docx"),
   mapping  = file.path(system.file(package="onbrand"), "templates", "report.yaml"))
obnd = preview_template(obnd)