modify_Theta {Certara.RDarwin} | R Documentation |
Modify Theta Parameters in PML Models
Description
This function allows to modify Theta parameter in a list of PML models
(PMLModels
class instance created by create_ModelPK()
or create_ModelPD).
Usage
modify_Theta(
PMLParametersSets,
Name,
InitialEstimates,
Frozen,
PMLStructures = NULL
)
Arguments
PMLParametersSets |
A list of PML parameters sets ( |
Name |
Character specifying the name of the Theta to be modified. |
InitialEstimates |
An |
Frozen |
A logical value indicating whether the Theta will be estimated or not. |
PMLStructures |
Character or character vector specifying names of PML
structures in which the |
Details
If the specified Theta does not exist in the PML models, a warning will be issued, and no modifications will be made. Thetas associated with structural parameters in the proportional part of MixRatio and Additive+Proportional error models can also be modified.
The current functionality does not support modifying custom thetas (fixefs) that are defined within the PML code of custom model spaces.
Value
An updated list of PML models (PMLModels
class instance) matching
the specified options.
See Also
Functions used for Theta specification:
InitialEstimate()
,
Theta()
,
create_ModelPD()
,
create_ModelPK()
Examples
PMLParametersSets <- create_ModelPK(CompartmentsNumber = c(1, 2))
# Modify a Theta parameter named "tvV" with new Initial Estimates and
# Frozen flag
PMLParametersSetsMod1 <-
modify_Theta(PMLParametersSets,
Name = "tvV",
Frozen = TRUE,
InitialEstimates = 0.3)
print(PMLParametersSetsMod1)
PMLParametersSetsMod2 <-
add_StParm(PMLParametersSets = PMLParametersSetsMod1,
StParmName = "Duration",
State = "Searched",
PMLStructures = "PK2IVC",
DosepointArgName = "duration")
PMLParametersSetsMod3 <-
modify_Theta(PMLParametersSets = PMLParametersSetsMod2,
Name = "tvDuration",
InitialEstimates = c(2, 4, Inf))
print(PMLParametersSetsMod3)