mkdGeneralTitledMsg-easyreporting-method: mkdGeneralTitledMsg

In drighelli/easyreporting: Helps creating report for improving Reproducible Computational Research

Description

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

Usage

## 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

## Not run: 
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")

## End(Not run)

drighelli/easyreporting documentation built on March 22, 2021, 9:12 p.m.