Skip to contents

RMD docx template for TWRI

Source: R/twri_rmd.R
twri_docx.Rd

[Deprecated]

Development on twri_docx() is complete. It is recommended to use officedown::rdocx_document() directly. This function is retained for older templates that include the function, although rendered documents might be inconsistent. It is suggested to update any reports to the latest version of twriTemplates as twri_docx() may be removed in future versions.

Loads an Rmarkdown template that will produce a Microsoft word document consistent with institute brand guidance.

Usage

twri_docx(
  base_format = "bookdown::word_document2",
  tables = list(),
  plots = list(),
  lists = list(),
  mapstyles = list(),
  page_size = list(),
  page_margins = list(),
  reference_num = TRUE,
  toc = FALSE,
  number_sections = TRUE,
  fig_captions = TRUE,
  reference_docx = "format.docx",
  ...
)

Arguments

base_format

character, either rmarkdown::word_document or bookdown::word_document2 (default)

tables

empty list, used by officedown::rdocx_document()

plots

empty list, used by officedown::rdocx_document()

lists

empty list, used by officedown::rdocx_document()

mapstyles

empty list, used by officedown::rdocx_document()

page_size

empty list, used by officedown::rdocx_document()

page_margins

empty list, used by officedown::rdocx_document()

reference_num

if TRUE text for references to sections will be the section number. If FALSE the text for references to sections will be the section title. Default is TRUE.

toc

logical defaults FALSE. The template utilizes the TOC function in Word that can be manually removed or customized.

number_sections

logical

fig_captions

logical

reference_docx

character, specifies the template document to use.

...

additional arguments to officedown::rdocx_document()