setOptionsList-easyreporting-method: setOptionsList

Description Usage Arguments Value Examples

Description

set an optionList to the class

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## S4 method for signature 'easyreporting'
setOptionsList(
  object,
  cacheFlag = TRUE,
  evalFlag = TRUE,
  echoFlag = TRUE,
  warningFlag = FALSE,
  showMessages = FALSE,
  includeFlag = TRUE,
  collapseFlag = FALSE,
  purlFlag = TRUE,
  errorFlag = TRUE,
  messageFlag = TRUE,
  highlightFlag = TRUE,
  promptFlag = FALSE,
  stripWhiteFlag = TRUE,
  tidyFlag = FALSE
)

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 version (default FALSE)

includeFlag

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

collapseFlag

boolean for collapsing the code chunk in the compiled version (default FALSE),

purlFlag

boolean for extracting the code chunk as R code in a separate R file (default TRUE),

errorFlag

boolean for including the error generated by the code chunk in the compiled version (default TRUE),

messageFlag

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

highlightFlag

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

promptFlag

boolean for including a ">" for the code chunk in the compiled version (default FALSE),

stripWhiteFlag

boolean for removing the white spaces at beginning/end of the code chunk in the compiled version (default TRUE),

tidyFlag

boolean for creating a tidy code chunk in the compiled version (default FALSE).

Value

none

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
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)

## End(Not run)

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