fst: Fetch Word Style

In onbrand: Templated Reporting Workflows in Word and PowerPoint

Fetch Word Style

Description

Retrieves the style name in Word for a specified onbrand style name.

Usage

fst(obnd, osn = NULL, verbose = TRUE)

Arguments

obnd	onbrand report object
osn	onbrand Word style name to fetch
verbose	Boolean variable when set to TRUE (default) messages will be displayed on the terminal; Messages will be included in the returned list.

Value

List with the following elements

• wsn: Word style name that corresponds to the specified onbrand style name (osn)

• dff: Default font format for that style (the corresponding md_def section of the yaml file for that style)

• isgood: Boolean variable indicating success or failure

• msgs: Vector of messages

Examples

# Creating an onbrand object:
obnd = read_template(
      template = file.path(system.file(package="onbrand"), "templates", "report.docx"),
      mapping  = file.path(system.file(package="onbrand"), "templates", "report.yaml"))

# Pulling out the placeholder information:
st = fst(obnd, "Heading_3")

onbrand documentation built on May 29, 2024, 11:17 a.m.