A class for storage of numerical x- and y-value pairs and optional error for y-values.
Active bindings
nameThe name of the DataSet
dataRepositoryThe underlying DataRepository object
xDimensionDimension in which the xValues are defined
xUnitUnit in which the xValues are defined
xValuesValues stored in the xUnit. This field is read-only. Use
$setValues()to change the values.yDimensionDimension in which the yValues are defined
yUnitUnit in which the yValues are defined
yValuesValues stored in the yUnit. This field is read-only. Use
$setValues()to change the values.yErrorTypeType of the error - geometric or arithmetic. When changing from arithmetic to geometric error, the values are considered in as fraction (1 = 100%). When changing from geometric to arithmetic, the values are set to the same unit as
yErrorUnit. In case no yError is defined, the value isNULLand cannot be changedyErrorUnitUnit in which the yErrorValues are defined. For arithmetic error, the unit must be valid for
yDimension. For geometric error, the unit must be valid forDimensionless. In case no yError is defined, the value isNULLand cannot be changedyErrorValuesValues of error stored in the yErrorUnit unit. This field is read-only. Use
$setValues()to change the values. In case no yError is defined, the value isNULLand cannot be changed. Use$setValues()to change the values.molWeightMolecular weight of the yValues in g/mol
LLOQLower Limit Of Quantification. Value in yUnit associated with the yValues
subjectCountNumber of subjects from which the y values and the error values are calculated, e.g. for aggregated data reported as mean and standard deviation. One positive whole number, or
NULLif not set. Set it toNULLorNAto remove it.outputPathPath of the simulation output that the observed data belongs to, e.g.
"Organism|PeripheralVenousBlood|Aciclovir|Plasma (Peripheral Venous Blood)", orNULLif not set. It is stored as the meta data entryOutputPath. When the data set is used in PK-Sim or MoBi version 13 or later, it is mapped automatically to the output with exactly this path. The path must match exactly, including upper and lower case. Set it toNULL,NA, or""to remove it. A path of only spaces is treated as not set.metaDataReturns a named list of meta data defined for the data set.
Methods
DataSet$new()
Initialize a new instance of the class.
Either create a DataSet from a DataRepository (e.g. loaded from a PKML)
or an empty DataSet. In case of an empty DataSet, a name must be
provided.
Usage
DataSet$new(name = NULL, dataRepository = NULL)DataSet$addMetaData()
Adds a new entry to meta data list or changes its value if the name is already present.
DataSet$setValues()
Sets the xValues, yValues, and (optionally) yErrorValues into the dataSet. Note: xValues, yValues and yErrorValues must have the same length