add_iiv: add_iiv

In pharmr: Interface to the 'Pharmpy' 'Pharmacometrics' Library

add_iiv

Description

Adds IIVs to :class:pharmpy.model.

Effects that currently have templates are:

• Additive (add)

• Proportional (prop)

• Exponential (exp)

• Logit (log)

• Rescaled logit (re_log)

For all except exponential the operation input is not needed. Otherwise user specified input is supported. Initial estimates for new etas are 0.09.

Assuming a statement (equation could not be rendered, see API doc on website)

• Additive: (equation could not be rendered, see API doc on website)

• Proportional: (equation could not be rendered, see API doc on website)

• Exponential: (equation could not be rendered, see API doc on website)

• Logit: (equation could not be rendered, see API doc on website)

• Rescaled logit: (equation could not be rendered, see API doc on website) with (equation could not be rendered, see API doc on website)

Usage

add_iiv(
  model,
  list_of_parameters,
  expression,
  operation = "*",
  initial_estimate = 0.09,
  eta_names = NULL
)

Arguments

model	(Model) Pharmpy model to add new IIVs to.
list_of_parameters	(array(str) or str) Name/names of parameter to add new IIVs to.
expression	(array(str) or str) Effect/effects on eta. Either abbreviated (see above) or custom.
operation	(str) Whether the new IIV should be added or multiplied (default).
initial_estimate	(numeric) Value of initial estimate of parameter. Default is 0.09
eta_names	(array(str) (optional)) Custom name/names of new eta

Value

(Model) Pharmpy model object

See Also

add_pk_iiv

add_iov

remove_iiv

remove_iov

Examples

## Not run: 
model <- load_example_model("pheno")
model <- remove_iiv(model, "CL")
model <- add_iiv(model, "CL", "add")
model$statements$find_assignment("CL")

## End(Not run)

pharmr documentation built on June 8, 2025, 11:22 a.m.