GofPlotTask: GofPlotTask

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

GofPlotTask

Description

R6 class for GofPlotTask settings

Super classes

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

Methods

Public methods

• GofPlotTask$saveResults()

• GofPlotTask$saveResidualsResults()

• GofPlotTask$runTask()

• GofPlotTask$getResidualsResults()

• GofPlotTask$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::PlotTask$initialize()

---

Method saveResults()

Save the task results related to a 'structureSet'.

Usage

GofPlotTask$saveResults(structureSet, taskResults)

Arguments

structureSet

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

taskResults

list of 'TaskResults' objects

---

Method saveResidualsResults()

Save the task results related to residuals across all simulations

Usage

GofPlotTask$saveResidualsResults(taskResults)

Arguments

taskResults

list of 'TaskResults' objects

---

Method runTask()

Run task and save its output results

Usage

GofPlotTask$runTask(structureSets)

Arguments

structureSets

list of 'SimulationStructure' objects

---

Method getResidualsResults()

Get plot results for residuals across all simulations

Usage

GofPlotTask$getResidualsResults(structureSets, data, settings)

Arguments

structureSets

A list of 'SimulationStructure' objects defining the properties of a simulation set

data

data.frame

settings

List of settings such as 'PlotConfiguration' R6 class objects for each goodness of fit plot

Returns

A list of 'TaskResults' objects

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GofPlotTask$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

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