Function reference • ospsuite.reportingengine

Working with Workflow objects

Functions and classes for creating and working with Workflow objects

MeanModelWorkflow: MeanModelWorkflow

PopulationWorkflow: PopulationWorkflow

QualificationWorkflow: QualificationWorkflow

activateWorkflowTasks(): activateWorkflowTasks

addStudyParameters(): addStudyParameters

addXParametersForDemogrpahyPlot(): addXParametersForDemogrpahyPlot

addXParametersForPKParametersPlot() addXParametersForPkParametersPlot(): addXParametersForPKParametersPlot

addYParametersForDemogrpahyPlot(): addYParametersForDemogrpahyPlot

addYParametersForPKParametersPlot() addYParametersForPkParametersPlot(): addYParametersForPKParametersPlot

checkTaskInputsExist(): checkTaskInputsExist

getMeanSensitivityAnalysisResultsFileNames(): getMeanSensitivityAnalysisResultsFileNames

getOutputPathsInSimulationSet(): getOutputPathsInSimulationSet

getPKAnalysisResultsFileNames() getPkAnalysisResultsFileNames(): getPKAnalysisResultsFileNames

getPKParametersInOutput(): getPKParametersInOutput

getPKParametersInSimulationSet(): getPKParametersInSimulationSet

getPopulationSensitivityAnalysisResultsFileNames(): getPopulationSensitivityAnalysisResultsFileNames

getSimulationDescriptor(): getSimulationDescriptor

getSimulationParameterDisplayPaths(): getSimulationParameterDisplayPaths

getSimulationResultFileNames(): getSimulationResultFileNames

getTaskInputs(): getTaskInputs

getWorkflowParameterDisplayPaths(): getWorkflowParameterDisplayPaths

getXParametersForDemogrpahyPlot(): getXParametersForDemogrpahyPlot

getXParametersForPKParametersPlot() getXParametersForPkParametersPlot(): getXParametersForPKParametersPlot

getYParametersForDemogrpahyPlot(): getYParametersForDemogrpahyPlot

getYParametersForPKParametersPlot() getYParametersForPkParametersPlot(): getYParametersForPKParametersPlot

inactivateWorkflowTasks(): inactivateWorkflowTasks

setSimulationDescriptor(): setSimulationDescriptor

setWorkflowParameterDisplayPaths(): setWorkflowParameterDisplayPaths

setWorkflowParameterDisplayPathsFromFile(): setWorkflowParameterDisplayPathsFromFile

setXParametersForDemogrpahyPlot(): setXParametersForDemogrpahyPlot

setXParametersForPKParametersPlot() setXParametersForPkParametersPlot(): setXParametersForPKParametersPlot

setYParametersForDemogrpahyPlot(): setYParametersForDemogrpahyPlot

setYParametersForPKParametersPlot() setYParametersForPkParametersPlot(): setYParametersForPKParametersPlot

Simulation Sets and Outputs

Classes required for creating workflows

getOutputPathsInSimulationSet(): getOutputPathsInSimulationSet

getPKParametersInSimulationSet(): getPKParametersInSimulationSet

PopulationSimulationSet: PopulationSimulationSet

SimulationSet: SimulationSet

getPKParametersInOutput(): getPKParametersInOutput

Output: Output

PkParameterInfo: PkParameterInfo

Workflow tasks

Functions and classes for creating and working with workflow tasks

addUserDefinedTask(): addUserDefinedTask

GofPlotTask: GofPlotTask

loadCalculatePKParametersTask(): loadCalculatePKParametersTask

loadCalculateSensitivityTask(): loadCalculateSensitivityTask

loadGOFMergedTask(): loadGOFMergedTask

loadPlotAbsorptionTask(): loadPlotAbsorptionTask

loadPlotDDIRatioTask(): loadPlotDDIRatioTask

loadPlotDemographyTask(): loadPlotDemographyTask

loadPlotMassBalanceTask(): loadPlotMassBalanceTask

loadPlotPKParametersTask(): loadPlotPKParametersTask

loadPlotPKRatioTask(): loadPlotPKRatioTask

loadPlotSensitivityTask(): loadPlotSensitivityTask

loadPlotTimeProfilesAndResidualsTask(): loadPlotTimeProfilesAndResidualsTask

loadQualificationComparisonTimeProfileTask(): loadQualificationComparisonTimeProfileTask

loadQualificationTimeProfilesTask(): loadPlotTimeProfilesTask

loadSimulateTask(): loadSimulateTask

PlotTask: PlotTask

PopulationPlotTask: PopulationPlotTask

PopulationSensitivityAnalysisTask: PopulationSensitivityAnalysisTask

QualificationTask: QualificationTask

SensitivityAnalysisTask: SensitivityAnalysisTask

Task: Task

Qualification Workflows

Functions and classes dedicated to Qualification Workflows

adjustTitlePage(): adjustTitlePage

ConfigurationPlan: ConfigurationPlan

loadConfigurationPlan(): loadConfigurationPlan

loadQualificationWorkflow(): loadQualificationWorkflow

startQualificationRunner(): startQualificationRunner

Writing and formatting reports

Functions for facilitating the writing and formatting of markdown and word reports

addFigureChunk(): addFigureChunk

addTableChunk(): addTableChunk

addTextChunk(): addTextChunk

anchor(): anchor

copyReport(): copyReport

getAnchorName(): getAnchorName

hasAnchor(): hasAnchor

mergeMarkdownFiles(): mergeMarkdownFiles

renderReport(): renderReport

renderWordReport(): renderWordReport

resetReport(): resetReport

Enum Helpers

Enums listing available values for specific properties

AllAvailableTasks: AllAvailableTasks

ApplicationRanges: ApplicationRanges

DataSelectionKeys: DataSelectionKeys

PopulationWorkflowTypes: PopulationWorkflowTypes

ResidualScales: ResidualScales

StandardPlotTasks: StandardPlotTasks

StandardSimulationTasks: StandardSimulationTasks

Default Settings

Functions for defining default package or workflow settings.

setDefaultAutoAxisLimitMargin(): setDefaultAutoAxisLimitMargin

setDefaultBins(): setDefaultBins

setDefaultNumericFormat(): setDefaultNumericFormat

setDefaultPlotFormat(): setDefaultPlotFormat

setDefaultStairstep(): setDefaultStairstep

setDefaultTheme(): setDefaultTheme

setDefaultThemeFromJson(): setDefaultThemeFromJson

setWatermarkConfiguration(): setWatermarkConfiguration

getDefaultDemographyXParameters(): getDefaultDemographyXParameters

getDefaultPKParametersXParameters() getDefaultPkParametersXParameters(): getDefaultPKParametersXParameters

Simulated and observed data helpers

Helper functions for working with simulated and observed data.

calculateArithmeticErrorRange(): calculateArithmeticErrorRange

calculateGeometricErrorRange(): calculateGeometricErrorRange

calculateGMFE(): calculateGMFE

calculateResiduals(): calculateResiduals

getResiduals(): getResiduals

isBetween(): isBetween

measureValuesBetween(): measureValuesBetween

readObservedDataFile(): readObservedDataFile

lastPathElement(): lastPathElement

evalDataFilter(): evalDataFilter

loadSimulationWithUpdatedPaths(): loadSimulationWithUpdatedPaths

loadWorkflowPopulation(): loadWorkflowPopulation