add_StParm {Certara.RDarwin} | R Documentation |
Add Structural parameter into PML models Dosepoints
Description
Add Structural parameter into PML models Dosepoints
Usage
add_StParm(
PMLParametersSets,
StParmName,
Type = "LogNormal",
State = "Present",
ThetaStParm = list(),
OmegaStParm = list(),
Covariates = list(),
PMLStructures = NULL,
DosepointArgName = character()
)
Arguments
PMLParametersSets |
A list of PML parameters sets ( |
StParmName |
Character specifying the name of the structural parameter to be added. |
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
|
DosepointArgName |
Character specifying the name of the argument in the
|
Details
only special
Dosepoint()
related structural parameters could be added to built-in models (i.e. created using eithercreate_ModelPD()
orcreate_modelPK()
. Due to ambiguity of situation when a structural parameter is added withState == 'None'
, a warning is given for such cases.A structural parameter could be added to the custom model if it not presented in the model yet (as a custom or built-in structural parameter).
Value
An updated list of PML models (PMLModels
class instance) matching
the specified options.
See Also
Functions used for StParm specification:
StParm()
,
create_ModelPD()
,
create_ModelPK()
,
modify_StParm()
,
modify_StParmCustom()
,
remove_StParm()
Examples
PMLParametersSets <-
get_PMLParametersSets(CompartmentsNumber = c(1, 2, 3))
# add Rate structural parameter for all PMLModels
PMLParametersSetsVModDuration <-
add_StParm(PMLParametersSets,
StParmName = "Duration",
ThetaStParm = Theta("tvD",
InitialEstimates = 2),
OmegaStParm = Omega(Name = "nD",
State = "Searched"),
DosepointArgName = "duration")