R6 class for Reporting Engine Population Workflow
See also
Other workflows:
MeanModelWorkflow,
QualificationWorkflow
Super class
ospsuite.reportingengine::Workflow -> PopulationWorkflow
Public fields
workflowTypeType of population workflow
simulateSimulationTaskobject for time profile simulationscalculatePKParametersCalculatePKParametersTaskobject for PK parameters calculationcalculateSensitivitySensitivityAnalysisTaskobject for sensitivity analysisplotDemographyR6 class
Taskfor demography plotsplotTimeProfilesAndResidualsPlotTaskobject for goodness of fit plotsplotPKParametersR6 class
Taskfor PK parameters plotplotSensitivityR6 class
Taskfor sensitivity plot
Methods
Inherited methods
ospsuite.reportingengine::Workflow$activateTasks()ospsuite.reportingengine::Workflow$getActiveTasks()ospsuite.reportingengine::Workflow$getAllPlotTasks()ospsuite.reportingengine::Workflow$getAllTasks()ospsuite.reportingengine::Workflow$getInactiveTasks()ospsuite.reportingengine::Workflow$getParameterDisplayPaths()ospsuite.reportingengine::Workflow$getSimulationDescriptor()ospsuite.reportingengine::Workflow$getWatermark()ospsuite.reportingengine::Workflow$inactivateTasks()ospsuite.reportingengine::Workflow$print()ospsuite.reportingengine::Workflow$printReportingEngineInfo()ospsuite.reportingengine::Workflow$setParameterDisplayPaths()ospsuite.reportingengine::Workflow$setSimulationDescriptor()ospsuite.reportingengine::Workflow$setWatermark()
Method new()
Create a new PopulationWorkflow object.
Usage
PopulationWorkflow$new(
workflowType,
simulationSets,
workflowFolder,
createWordReport = TRUE,
watermark = NULL,
simulationSetDescriptor = NULL,
numberSections = TRUE,
reportTitle = NULL,
theme = NULL
)Arguments
workflowTypeType of population workflow. Use enum
PopulationWorkflowTypesto get list of workflow types.simulationSetslist of
SimulationSetR6 class objectsworkflowFolderpath of the output folder created or used by the Workflow.
createWordReportlogical of option for creating Markdown-Report only but not a Word-Report.
watermarkdisplayed watermark in every plot background
simulationSetDescriptorcharacter Descriptor of simulation sets indicated in reports
numberSectionslogical defining if the report sections should be numbered
reportTitlereport title internally added as a cover page If
reportTitleis an existing file, it will be merged to the report as cover page.themeA
Themeobject from{tlf}package
Method runWorkflow()
Run population workflow tasks for all simulation sets if tasks are activated The order of tasks is as follows:
Run simulations
Perform PK and sensitivity analyses
Perform plot tasks
a. time profiles and residual plots
b. demography plots
c. PK and sensitivity analyses tables and plotsRender report