mkdGeneralTitledMsg-easyreporting-method: mkdGeneralTitledMsg

Description Usage Arguments Value Examples

Description

It appends a a titled section followed by a general message to the report. Useful for adding natural language comments.

Usage

1
2
## S4 method for signature 'easyreporting'
mkdGeneralTitledMsg(object, title = NULL, level = 1, message)

Arguments

object

an easyreporting class object

title

the optional title to give to the message section

level

the level (1 to 6) of the title (default is 1)

message

the message to append to the report

Value

none

Examples

1
2
3
4
rd <- easyreporting(filenamePath="./project_report",
                        title="example_report", author=c("It's me"))
mkdGeneralTitledMsg(rd, title="Generic SubTitle for this message", level=2,
        message="Writing a paragraph to describe my code chunk")

easyreporting documentation built on Nov. 8, 2020, 8:01 p.m.