Skip to contents

Modify structural parameter in PML models set

modify_StParm.Rd

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 (PMLModels class instance).

StParmName

Character specifying the name of the structural parameter to be modified.

Type

Character specifying the type of the structural parameter. Options are

  • LogNormal The PML statement of the structural parameter will look like the following:

stparm(V = tvV * wt^dVdwt * exp(nV + nVx0*(Occasion==0) + nVx1*(Occasion==1)))

  • LogNormal1 The PML statement of the structural parameter will look like the following:

stparm(V = (tvV + wt*dVdwt) * exp(nV + nVx0*( Occasion==0) + nVx1*( Occasion==1)))

  • LogNormal2 The PML statement of the structural parameter will look like the following:

stparm(V = exp(tvV + wt*dVdwt + nV + nVx0*(Occasion==0) + nVx1*(Occason==1)))

  • LogitNormal The PML statement of the structural parameter will look like the following:

stparm(V = ilogit(tvV + wt*dVdwt + nV + nVx0*(Occasion==0) + nVx1*(Occasion==1)))

  • Normal The PML statement of the structural parameter will look like the following:

stparm(V = tvV + wt*dVdwt + nV + nVx0*(Occasion==0) + nVx1*(Occasion==1))

State

character string that indicates the presence of the structural parameter. Options are:

  • None The structural parameter does not exist in the specified PMLStructures.

  • Present The structural parameter exists in the specified PMLStructures (the default).

  • Searched The presence of the structural parameter is searched.

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" + StParmName.

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" + StParmName

Covariates

A list of covariates (Covariate instances) that should be included in the structural parameter statement.

PMLStructures

Character or character vector specifying names of PML structures to which the structural parameter will be added. For the naming convention of PMLStructures, see Details section of get_PMLParametersSets().

Value

An updated list of PML models (PMLModels class instance) matching the specified options.

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().

See also

Dosepoint() list_StParms()

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")