StParm {Certara.RDarwin} | R Documentation |
Create an instance of a Structural parameter.
Description
This function creates a new instance of a Structural parameter.
Usage
StParm(
StParmName = character(),
Type = "LogNormal",
State = "Present",
ThetaStParm = list(),
OmegaStParm = list(),
Covariates = list(),
PMLStructure = character()
)
Arguments
StParmName |
Character specifying the name of the structural parameter. |
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 ( |
PMLStructure |
Character specifying the name of PML
structure for which current parameter should be attributed. For the
naming convention of PMLStructures, see Details section of
|
Value
An instance of a structural parameter.
See Also
Functions used for StParm specification:
add_StParm()
,
create_ModelPD()
,
create_ModelPK()
,
modify_StParm()
,
modify_StParmCustom()
,
remove_StParm()
Examples
# Create a Structural parameter instance with default values
V <- StParm(StParmName = "V")
# Create a Structural parameter with Normal type:
V2 <- StParm("V2",
Type = "Normal",
ThetaStParm = Theta(Name = "tvV2", InitialEstimates = 0.1))
# Create a Structural parameter instance with covariates:
Cl <- StParm(
StParmName = "Cl",
Covariates = Covariate(
Name = "Period",
Type = "Occasion",
State = "Searched",
Categories = c(1,2),
Omegas = list(Omega(Name = "nPeriodx1", 2),
Omega(Name = "nPeriodx2", 3))),
PMLStructure = "1CFOE")