SAOutput

R6 class defining a model output object

Active bindings

path: is the path to the output within the simulation PKML simulation.
displayName: is the display name for the output in lieu of the output path in the simulation PKML simulation.
pkParameterList: The list of PK parameters for this instance of the SAOutput.
dimension: The dimension of this instance of the SAOutput.
unit: The display unit of this instance of the SAOutput.

Create a new SAOutput object.

SAOutput$new(simulation, path, displayName = NULL, unit = NULL)

simulation: simulation A PKML simulation in which the parameter exists.
path: A PKML simulation in which the output exists.
displayName: A shorthand string for the output that substitutes for the path for display purposes.
unit: A valid OSP unit that will be the display unit for this instance of the SAOutput object.

An instance of the SAOutput class.

Add PK parameter to be evaluated for the SAOutput instance.

SAOutput$addPKParameter(
  standardPKParameter,
  pkParameterDisplayName = NULL,
  startTime = NULL,
  endTime = NULL
)

standardPKParameter: A standard PK parameter selected from among the list of strings in ospsuite::allPKParameterNames().
pkParameterDisplayName: A shorthand string for the parameter that substitutes for the path for display purposes.
startTime: Start time within the simulation run for calculation of the PK parameter.
endTime: End time within the simulation run for calculation of the PK parameter.

The objects of this class are cloneable with this method.

SAOutput$clone(deep = FALSE)