PopulationPlotTask: PopulationPlotTask

In Open-Systems-Pharmacology/OSPSuite.ReportingEngine: R package to create reports for the Open Systems Pharmacology models

PopulationPlotTask

Description

R6 class for PopulationPlotTask settings

Super classes

ospsuite.reportingengine::Task -> ospsuite.reportingengine::PlotTask -> PopulationPlotTask

Public fields

workflowType

Type of population workflow

xParameters

list of parameter paths to be plotted along x-axis

yParameters

list of parameter paths to be plotted along y-axis

Methods

Public methods

• PopulationPlotTask$new()

• PopulationPlotTask$saveResults()

• PopulationPlotTask$runTask()

• PopulationPlotTask$clone()

Inherited methods

• ospsuite.reportingengine::Task$activate()
• ospsuite.reportingengine::Task$getAbsolutePath()
• ospsuite.reportingengine::Task$getInputs()
• ospsuite.reportingengine::Task$getRelativePath()
• ospsuite.reportingengine::Task$inactivate()
• ospsuite.reportingengine::Task$print()
• ospsuite.reportingengine::Task$validateInput()
• ospsuite.reportingengine::Task$validateStructureSetInput()

---

Method new()

Create a 'PopulationPlotTask' object

Usage

PopulationPlotTask$new(
  workflowType = PopulationWorkflowTypes$parallelComparison,
  xParameters = NULL,
  yParameters = NULL,
  ...
)

Arguments

workflowType

Type of population workflow. Use enum 'PopulationWorkflowTypes' to get list of workflow types.

xParameters

list of parameter paths to be plotted along x-axis

yParameters

list of parameter paths to be plotted along y-axis

...

input parameters inherited from 'PlotTask' R6 class

Returns

A new 'PopulationPlotTask' object

---

Method saveResults()

Save the task results

Usage

PopulationPlotTask$saveResults(taskResults)

Arguments

taskResults

list of 'TaskResults' objects

---

Method runTask()

Run task and save its output

Usage

PopulationPlotTask$runTask(structureSets)

Arguments

structureSets

list of 'SimulationStructure' R6 class

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PopulationPlotTask$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other workflow tasks: GofPlotTask, PlotTask, PopulationSensitivityAnalysisTask, QualificationTask, SensitivityAnalysisTask, Task, addUserDefinedTask(), loadCalculatePKParametersTask(), loadCalculateSensitivityTask(), loadGOFMergedTask(), loadPlotAbsorptionTask(), loadPlotDDIRatioTask(), loadPlotDemographyTask(), loadPlotMassBalanceTask(), loadPlotPKParametersTask(), loadPlotPKRatioTask(), loadPlotSensitivityTask(), loadPlotTimeProfilesAndResidualsTask(), loadQualificationComparisonTimeProfileTask(), loadQualificationTimeProfilesTask(), loadSimulateTask()

Open-Systems-Pharmacology/OSPSuite.ReportingEngine documentation built on March 30, 2024, 4:17 p.m.