modify_Observation {Certara.RDarwin} | R Documentation |
Modify Observation class in PML models
Description
Modify Observation class in PML models
Usage
modify_Observation(
PMLParametersSets,
ObservationName,
SigmasChosen,
BQL,
BQLValue,
Frozen,
ResetObs,
Covariates,
PMLStructures = NULL
)
Arguments
PMLParametersSets |
A list of PML parameters sets ( |
ObservationName |
A character string giving the name of the Observation. |
SigmasChosen |
a Sigmas class instance or a list specifying the chosen sigma values for different error models. 0s are treated as no values. Inside Observation class it is transormed and kept as Sigmas class. The list could contain the following error models:
|
BQL |
A logical value indicating whether the dataset contains BQL values and they should be taken into account (M3 method). |
BQLValue |
An optional numeric positive value of static LLOQ. Applicable
only when BQL argument is |
Frozen |
A logical value indicating if the standard deviation (Stdev) is frozen. |
ResetObs |
A logical value indicating if the Observation variable should
be reset to 0 after observation ( |
Covariates |
A list of covariates ( |
PMLStructures |
Character or character vector specifying names of PML
structures in which the observation will be modified. For the naming
convention of PMLStructures, see Details section of
|
Details
This function can only be used to modify the structural parameters
in the built-in models (i.e., created using either create_ModelEmax()
or
create_ModelPK()
).
Value
An updated list of PML models (PMLModels
class instance) matching
the specified options.
See Also
Functions used for Observation specification:
Observation()
,
ObservationCustom()
,
Sigmas()
,
create_ModelPD()
,
create_ModelPK()
,
remove_Observation()
Examples
PMLParametersSets <-
create_ModelPK(CompartmentsNumber = c(1, 2, 3))
# update structural paramter type
PMLParametersSetsVMod <-
modify_Observation(
PMLParametersSets,
ObservationName = "CObs",
SigmasChosen = Sigmas(Proportional = 0,
AdditiveMultiplicative =
list(PropPart = 0.1, AddPart = 10)))
print(PMLParametersSetsVMod)