PopulationSensitivityAnalysisTask: PopulationSensitivityAnalysisTask

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

PopulationSensitivityAnalysisTask

Description

R6 class for PopulationSensitivityAnalysisTask settings

Super classes

ospsuite.reportingengine::Task -> ospsuite.reportingengine::SensitivityAnalysisTask -> PopulationSensitivityAnalysisTask

Public fields

getTaskResults

function called by task that computes and format figure results

settings

A 'SensitivityAnalysisSettings' object

Methods

Public methods

• PopulationSensitivityAnalysisTask$new()

• PopulationSensitivityAnalysisTask$saveResults()

• PopulationSensitivityAnalysisTask$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()
• ospsuite.reportingengine::SensitivityAnalysisTask$runTask()

---

Method new()

Create a 'PopulationSensitivityAnalysisTask' object

Usage

PopulationSensitivityAnalysisTask$new(
  getTaskResults = NULL,
  settings = NULL,
  ...
)

Arguments

getTaskResults

function called by task that computes and format figure results

settings

'SensitivityAnalysisSettings' object

...

parameters inherited from R6 class 'SensitivityAnalysisTask' object

Returns

A new 'PopulationSensitivityAnalysisTask' object

---

Method saveResults()

Save the task results related to a 'structureSet'.

Usage

PopulationSensitivityAnalysisTask$saveResults(structureSet, taskResults)

Arguments

structureSet

A 'SimulationStructure' object defining the properties of a simulation set

taskResults

list of results from task run

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PopulationSensitivityAnalysisTask$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other workflow tasks: GofPlotTask, PlotTask, PopulationPlotTask, 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 Sept. 13, 2024, 11:36 a.m.