SensitivityAnalysisTask: SensitivityAnalysisTask

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

SensitivityAnalysisTask

Description

R6 class for SensitivityAnalysisTask settings

Super class

ospsuite.reportingengine::Task -> SensitivityAnalysisTask

Public fields

getTaskResults

function called by task that computes and format figure results

settings

instance of SensitivityAnalysisSettings class

nameTaskResults

name of function that returns task results

Methods

Public methods

• SensitivityAnalysisTask$new()

• SensitivityAnalysisTask$saveResults()

• SensitivityAnalysisTask$runTask()

• SensitivityAnalysisTask$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 'SensitivityAnalysisTask' object

Usage

SensitivityAnalysisTask$new(
  getTaskResults = NULL,
  settings = NULL,
  nameTaskResults = "none",
  ...
)

Arguments

getTaskResults

function called by task that computes and format figure results

settings

'SensitivityAnalysisSettings' object

nameTaskResults

name of function that returns task results

...

parameters inherited from R6 class 'Task' object

Returns

A new 'SensitivityAnalysisTask' object

---

Method saveResults()

Save the task results related to a 'structureSet'.

Usage

SensitivityAnalysisTask$saveResults(structureSet, taskResults)

Arguments

structureSet

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

taskResults

list of results from task run.

---

Method runTask()

Run task and save its output results

Usage

SensitivityAnalysisTask$runTask(structureSets)

Arguments

structureSets

list of 'SimulationStructure' objects

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SensitivityAnalysisTask$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other workflow tasks: GofPlotTask, PlotTask, PopulationPlotTask, PopulationSensitivityAnalysisTask, QualificationTask, 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.