mkdVariableAssignment-easyreporting-method: mkdVariableAssignment

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

Description

it includes a variable assignment in the report. NB: a call to the "mkdCodeChunkSt" has to be done before using it.

Usage

## S4 method for signature 'easyreporting'
mkdVariableAssignment(
  object,
  variable.name,
  variable.object.name,
  show = FALSE
)

Arguments

object	an easyreporting class object
variable.name	a string indicating the name of the variabe to store in the report. (This can be changed here, but further uses of the variable needs to take into account the variable name change).
variable.object.name	the name of the already existing variable. (This cannot be canged.)
show	a boolean indicating if to show the message before writing it into the rmardown file.

Value

none

Examples

## Not run: 
rd <- easyreporting(filenamePath="./project_report",
                        title="example_report", author=c("It's me"))
## leaving the default options to the code chunk
mkdCodeChunkSt(rd)
## adding a variable assignement
variable <- 1
mkdVariableAssignment(rd, "variable", "variable", show=TRUE)
mkdCodeChunkEnd(rd)

## End(Not run)

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