Insert a Comment Section

Insert a comment section in RMarkdown reports. Use this function within a code chunk and make sure to set the chunk option results = 'asis'.

report_Comment(level = 1, text, delim)

Arguments

level	integer (required): A non-negative integer specifying the section level.
text	character (optional): The comment text to be inserted in the section.
delim	character (required): Keyword specifying the delimiter insterted before the section. Usually "<br>" or "<hr>" for HTML and "\\newpage" for PDF reports.

Value

Text output via cat.

Examples

report_Comment(level = 1, text = "My comment", delim = "\\newpage")
#> 
#> 
#> \newpage
#> 
#> # Comment
#> 
#> My comment
#>