Skip to contents

Add summary table containing key points of statistical release. Traditionally these consist of key points, images of arrows to indicate direction of change, and detailed description of the key points. This normal structure is produced in word and pdf formats, while the govspeak format includes only the two text columns. The govspeak format also highlights key words indicating direction of change in the description.

Usage

add_summary_table(
  left,
  middle = "",
  right,
  key_words = NULL,
  key_words_remove = NULL,
  format = "html"
)

Arguments

left

vector of key points which will appear in left column

middle

optional vector of arrow image calls which will appear in middle column. If not specified, a blank column will be included instead.

right

vector of descriptions of key points which will appear in right column

key_words

vector of key change words to highlight in right column. A preloaded vector of these key words is already included, but additional words can be added as desired.

key_words_remove

character vector of standard key words you would NOT like to highlight in bold (defaults to NULL)

format

string which identifies the outputs you would like three-column table to appear in. Set to HTML as default.