modify_StParm {Certara.RDarwin} | R Documentation |
Modify structural parameter in PML models set
Description
Modify structural parameter in PML models set
Usage
modify_StParm(
PMLParametersSets,
StParmName,
Type = "LogNormal",
State = "Present",
ThetaStParm,
OmegaStParm,
Covariates,
PMLStructures = NULL
)
Arguments
PMLParametersSets |
A list of PML parameters sets ( |
StParmName |
Character specifying the name of the structural parameter to be modified. |
Type |
Character specifying the type of the structural parameter. Options are
|
State |
character string that indicates the presence of the structural parameter. Options are:
|
ThetaStParm |
A Theta class instance inside the structural parameter. If
not given, the associated Theta will be automatically created with its name
set to "tv" + |
OmegaStParm |
An Omega class instance inside the structural parameter.
If not given, the associated Omega will be automatically created with its
name set to "n" + |
Covariates |
A list of covariates ( |
PMLStructures |
Character or character vector specifying names of PML
structures to whichthe structural parameter will be added. 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()
) or in the custom models if they are added with
add_StParm()
.
Value
An updated list of PML models (PMLModels
class instance) matching
the specified options.
See Also
Functions used for StParm specification:
StParm()
,
add_StParm()
,
create_ModelPD()
,
create_ModelPK()
,
modify_StParmCustom()
,
remove_StParm()
Examples
PMLParametersSets <-
get_PMLParametersSets(CompartmentsNumber = c(1, 2, 3))
# update structural parameter type
PMLParametersSetsVMod <-
modify_StParm(PMLParametersSets,
StParmName = "V",
Type = "LogitNormal")