mkdCodeChunkTitledCommented-easyreporting-method: mkdCodeChunkTitledCommented

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

Description

it creates a complete code chunk, adding a natural language comment before of it.

Usage

## S4 method for signature 'easyreporting'
mkdCodeChunkTitledCommented(
  object,
  title = NULL,
  level = 1,
  comment = NULL,
  code,
  optionList = getOptionsList(object),
  sourceFilesList = NULL
)

Arguments

object	an easyreporting class object
title	the title to assign to the code chunk section
level	the level of the title (default is 1)
comment	a string with the natural language comment for the chunk.
code	a string within the code.
optionList	a list of options (default is the class options).
sourceFilesList	a optional list of files to source inside the chunk.

Value

none

Examples

## Not run: 
rd <- easyreporting(filenamePath="./project_report",
                        title="example_report", author=c("It's me"))
optList <- makeOptionsList(includeFlag=TRUE, cacheFlag=TRUE)
mkdCodeChunkTitledCommented(rd, title="Title Example", level=1,
                comment="This is the comment of the following code chunk",
                code="a <- 1\n b <- 2\n(c <- a+b)\n", optionList=optList,
                sourceFilesList=NULL)

## End(Not run)

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