convert_rmd: Convert standard markdown file to govspeak

In moj-analytical-services/mojspeakr: Facilitates Producing Whitehall Publisher-Ready Outputs Using Rmarkdown

Convert standard markdown file to govspeak

Description

Convert markdown file to Whitehall Publisher (GOV.UK) govspeak markdown format

Usage

convert_rmd(
  path,
  remove_blocks = FALSE,
  sub_pattern = TRUE,
  page_break = "line"
)

Arguments

path	string; filename (including path) to *.md file for conversion
remove_blocks	bool; decision to remove block elements from *.md file. This includes code blocks and warnings
sub_pattern	bool or vector; decision to increase hashed headers by one level in *.md file. TRUE will substitute all, FALSE will substitute none, while a vector of the desired substitution levels allows individual headings to be modified as required. e.g. "#" will modify only first level headers.
page_break	string; chooses what page breaks are converted to on Whitehall. If "line", page breaks are replaced with a horizontal rule. If "none" they are replaced with a line break. If "unchanged" they are not removed.

moj-analytical-services/mojspeakr documentation built on April 13, 2025, 9 p.m.