chronicle (version 0.1.0)

add_text: Add text to a chronicle Rmarkdown report

Description

Add text to a chronicle Rmarkdown report

Usage

add_text(report, text, text_title = NULL, title_level = 2)

Arguments

report

character containing the text of an Rmarkdown report header (and possibly more chunks). Easily create one with chronicle::new_report()

text

The text that will be added to the report

text_title

The title of the text section. Default is NULL.

title_level

Level of the section title of this text (ie, number of # on Rmarkdown syntax.)

Value

The text of the Rmarkdown report plus an additional section with the text.

Examples

# NOT RUN {
html_report <- add_text(report = new_report(),
                        text = 'This is the text that will be seen outside of any chunk',
                        text_title = 'Text title')
cat(html_report)
# }