pharmr (version 1.4.0)

add_iov: add_iov

Description

Adds IOVs to :class:pharmpy.model.

Initial estimate of new IOVs are 10% of the IIV eta it is based on.

Usage

add_iov(
  model,
  occ,
  list_of_parameters = NULL,
  eta_names = NULL,
  distribution = "disjoint"
)

Value

(Model) Pharmpy model object

Arguments

model

(Model) Pharmpy model to add new IOVs to.

occ

(str) Name of occasion column.

list_of_parameters

(array(str) or str (optional)) List of names of parameters and random variables. Accepts random variable names, parameter names, or a mix of both.

eta_names

(array(str) or str (optional)) Custom names of new etas. Must be equal to the number of input etas times the number of categories for occasion.

distribution

(str) The distribution that should be used for the new etas. Options are 'disjoint' for disjoint normal distributions, 'joint' for joint normal distribution, 'explicit' for an explicit mix of joint and disjoint distributions, and 'same-as-iiv' for copying the distribution of IIV etas.

See Also

add_iiv

add_pk_iiv

remove_iiv

remove_iov

Examples

if (FALSE) {
model <- load_example_model("pheno")
model <- add_iov(model, "TIME", "CL")
model$statements$find_assignment("CL")
}