Workflow | R Documentation |
R6 class representing Reporting Engine generic Workflow
simulationStructures
SimulationStructure
R6 class object managing the structure of the workflow output
workflowFolder
path of the folder create by the Workflow
taskNames
Enum of task names
reportFileName
name of the Rmd report file
reportTitle
report title page
createWordReport
logical of option for creating Markdown-Report only but not a Word-Report.
wordConversionTemplate
optional docx template for rendering a tuned Word-Report document
userDefinedTasks
List of user-defined tasks (to update with loadUserDefinedTask)
numberSections
logical defining if the report sections should be numbered
reportFolder
Directory in which workflow report is saved
reportFilePath
Path of workflow report
new()
Create a new Workflow
object.
Workflow$new( simulationSets, workflowFolder, createWordReport = TRUE, wordConversionTemplate = NULL, watermark = NULL, simulationSetDescriptor = NULL, numberSections = TRUE, reportTitle = NULL, theme = NULL )
simulationSets
list of SimulationSet
R6 class objects
workflowFolder
path of the output folder created or used by the Workflow.
createWordReport
logical of option for creating Markdown-Report only but not a Word-Report.
wordConversionTemplate
optional docx template for rendering a tuned Word-Report document
watermark
displayed watermark in figures background
simulationSetDescriptor
character Descriptor of simulation sets indicated in reports
numberSections
logical defining if the report sections should be numbered
reportTitle
report title internally added as a cover page
If reportTitle
is an existing file, it will be merged to the report as cover page.
theme
A Theme
object from {tlf}
package
A new Workflow
object
getAllTasks()
Get a vector with all the names of the tasks within the Workflow
Workflow$getAllTasks()
Vector of Task
names
getAllPlotTasks()
Get a vector with all the names of the plot tasks within the Workflow
Workflow$getAllPlotTasks()
Vector of PlotTask
names
getActiveTasks()
Get a vector with all the names of active tasks within the Workflow
Workflow$getActiveTasks()
Vector of active Task
names
getInactiveTasks()
Get a vector with all the names of inactive tasks within the Workflow
Workflow$getInactiveTasks()
Vector of inactive Task
names
activateTasks()
Activates a series of Tasks
from current Workflow
Workflow$activateTasks(tasks = self$getAllTasks())
tasks
names of the workflow tasks to activate.
Default activates all tasks of the workflow using workflow method workflow$getAllTasks()
Vector of inactive Task
names
inactivateTasks()
Inactivates a series of Tasks
from current Workflow
Workflow$inactivateTasks(tasks = self$getAllTasks())
tasks
names of the workflow tasks to inactivate.
Default inactivates all tasks of the workflow using workflow method workflow$getAllTasks()
Vector of inactive Task
names
printReportingEngineInfo()
Print reporting engine information obtained from initializing a Workflow
Workflow$printReportingEngineInfo()
getWatermark()
Get the current watermark to be reported on figures background
Workflow$getWatermark()
setWatermark()
Set the watermark to be reported on figure background.
The default value NULL
leads to check if the computer has a validated environment.
If the environment is validated, no watermark is reported on the background.
If the environment is NOT validated, workflowWatermarkMessage
is reported on the background.
Any user-defined text will overwrite this default feature and be reported on the figure background.
Workflow$setWatermark(watermark)
watermark
text to be reported on figures background.
Default value is NULL
, which leads to check if the computer has a validated environment.
If the environment is validated, no watermark is reported on the background.
If the environment is NOT validated, workflowWatermarkMessage
is reported on the background.
Any user-defined text will overwrite this default feature and be reported on the figure background.
setParameterDisplayPaths()
Set mapping between parameters and their display paths in workflow to replace standard display of parameter paths.
Workflow$setParameterDisplayPaths(parameterDisplayPaths)
parameterDisplayPaths
data.frame mapping Parameters with their display paths
Variables of the data.frame should include parameter
and displayPath
.
getParameterDisplayPaths()
Get mapping between parameters and their display paths in workflow to replace standard display of parameter paths.
Workflow$getParameterDisplayPaths()
A data.frame with parameter
and displayPath
variables.
setSimulationDescriptor()
Set descriptor of simulation sets indicated in reports
Workflow$setSimulationDescriptor(text)
text
character describing what simulation sets refer to
getSimulationDescriptor()
Get descriptor of simulation sets indicated in reports
Workflow$getSimulationDescriptor()
character Descriptor of simulation sets
print()
Print workflow list of tasks
Workflow$print()
Task list information
clone()
The objects of this class are cloneable with this method.
Workflow$clone(deep = FALSE)
deep
Whether to make a deep clone.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.