structuralParameter: Set structural parameter in model object

In Certara.RsNLME: Pharmacometric Modeling

Set structural parameter in model object

Description

Use to specify the relationship of the structural parameter with corresponding fixed effect, random effect, and covariate.

Usage

structuralParameter(
  .Object,
  paramName,
  fixedEffName = NULL,
  randomEffName = NULL,
  style = "LogNormal",
  hasRandomEffect = NULL
)

Arguments

.Object	Model object
paramName	Name of the structural parameter
fixedEffName	Name of the corresponding fixed effect
randomEffName	Name of the corresponding random effect; only applicable to population models.
style	Use to specify the relationship of the structural parameter with its corresponding fixed effect, random effect, and covariate, if exists. "LogNormal" (Default): The structural parameter is defined as Product * exp(Eta) "LogNormal1": The structural parameter is defined as Sum * exp(Eta) "LogNormal2": The structural parameter is defined as exp(Sum + Eta) "LogitNormal": The structural parameter is defined as ilogit(Sum + Eta) "Normal": The structural parameter is defined as Sum + Eta) Product denotes the product of the corresponding fixed effect and covariate effect terms (if exists), Eta represents the corresponding random effect, and Sum denotes the sum of its corresponding fixed effect and covariate effect terms (if exists).
hasRandomEffect	Set to FALSE to remove the corresponding random effect from the model. Only applicable to population models. If NULL the system will automatically set hasRandomEffect = TRUE for population models, and hasRandomEffect = FALSE for individual models.

Value

Modified NlmePmlModel object

Examples

model <- pkindirectmodel(
  indirectType = "LimitedInhibition",
  isBuildup = FALSE,
  data = pkpdData,
  ID = "ID",
  Time = "Time",
  A1 = "Dose",
  CObs = "CObs",
  EObs = "EObs"
)

# Change style of structural parameter "Imax" to "LogitNormal"
# and rename fixed effect to "tvlogitImax"
model <- structuralParameter(model,
  paramName = "Imax",
  style = "LogitNormal", fixedEffName = "tvlogitImax"
)

# Remove random effect for structural parameter "IC50"
model <- structuralParameter(model,
  paramName = "IC50",
  hasRandomEffect = FALSE
)

Certara.RsNLME documentation built on April 3, 2025, 11:04 p.m.