setOptionsList {easyreporting}R Documentation

setOptionsList

Description

set an optionList to the class, it automatically sets the options for the rmarkdown file. Are useful for the interpretation/execution of the code chunks.

Usage

setOptionsList(
  object,
  cacheFlag = TRUE,
  evalFlag = TRUE,
  echoFlag = TRUE,
  warningFlag = FALSE,
  showMessages = FALSE,
  includeFlag = TRUE
)

Arguments

object

an easyreporting class object

cacheFlag

boolean for caching chunk data (default TRUE)

evalFlag

boolean for evaluating the code chunk in the compiled version (default TRUE)

echoFlag

boolean for showing the code chunk (default TRUE)

warningFlag

boolean for showing the chunk warnings (default FALSE)

showMessages

boolean for showing the chunk warnings in compiled

includeFlag

boolean for including the code chunk in the compiled version (default TRUE)

Value

none

Examples

rd <- easyreporting(filenamePath="./project_report",
                        title="example_report", author=c("It's me"))

## setting default option
setOptionsList(rd)

## modifying only some options
rd <- setOptionsList(rd, warningFlag=TRUE, 
        showMessages=TRUE, includeFlag=TRUE)


[Package easyreporting version 1.0.0 Index]