Skip to contents

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

Inherited methods


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.