modify_Omega {Certara.RDarwin} | R Documentation |
Modify Omega Parameters in PML Models
Description
This function allows to modify Omega parameters in a list of PML models
(PMLModels
class instance created by get_PMLParametersSets()
).
Usage
modify_Omega(
PMLParametersSets,
Name,
InitialOmega,
State,
Frozen,
PMLStructures = NULL
)
Arguments
PMLParametersSets |
A list of PML parameters sets ( |
Name |
A character string specifying the name of the Omega. |
InitialOmega |
Numeric specifying the initial value of the Omega. Default value is 1. |
State |
Character specifying the presence of the Omega. Possible values are:
|
Frozen |
A logical value indicating whether the Omega is frozen or not. |
PMLStructures |
Character or character vector specifying names of PML
structures in which the Omega will be modified. For the naming convention
of PMLStructures, see Details section of |
Details
If the specified Omega does not exist in the PML models, a warning will be issued, and no modifications will be made.
The current functionality does not support modifying custom omegas (ranefs) 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 Omega specification:
Omega()
,
create_ModelPD()
,
create_ModelPK()
Examples
PMLParametersSets12 <- create_ModelPK(CompartmentsNumber = c(1, 2))
# Modify an Omega parameter named "nV" with new Initial Estimate and
# Frozen flag
PMLParametersSets12Mod1 <-
modify_Omega(PMLParametersSets12,
Name = "nV",
InitialOmega = 0.3,
State = "Present",
Frozen = TRUE,
PMLStructures = "PK1IVC")
print(PMLParametersSets12Mod1)