onbrand (version 1.0.6)

fetch_md_def: Fetch Markdown Default Format from onbrand Object

Description

Used to extract the formatting elements for a given style from an onbrand object.

Usage

fetch_md_def(obnd, style = "default", verbose = TRUE)

Value

list with the following elements

• isgood: Boolean variable indicating success or failure

• md_def: List with the default format for the specified style

• msgs: Vector of messages

Arguments

obnd

onbrand report object

style

name of style in md_def for the report type in obnd to fetch ("default")

verbose

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

Examples

obnd = read_template(
   template = file.path(system.file(package="onbrand"), "templates", "report.docx"),
   mapping  = file.path(system.file(package="onbrand"), "templates", "report.yaml"))
obnd = fetch_md_def(obnd, style="default")
md_def =  obnd[["md_def"]]