pk_elimination_nl: PK elimination nonlinear

Description Usage Arguments Details Value See Also

View source: R/pk_component.R

Description

This building block declares a nonlinear elimination component for a pharmacokinetic model.

Usage

1
2
3
4
5
pk_elimination_nl(
  prm_clmm = prm_log_normal("clmm", median = 25, var_log = 0.1),
  prm_km = prm_log_normal("km", median = 0.5, var_log = 0.1),
  prm_vmax = NULL
)

Arguments

prm_clmm

Parameter model for the clearance

prm_km

Parameter model for KM (the half-maximal concentration)

prm_vmax

Parameter model for Vmax (the maximal elimination rate)

Details

PK components

PK components can be added to a pk_model and exist in three different types: absorption, distribution, and elimination. The absorption component is optional, distribution and elimination are not and need to be added for the PK model to be valid.

A PK model can only have one component of each type and adding a component with an already existing type will replace the previous definition. For example, the distribution component will be a two compartment model in the following snippet:

1
2
3
4
5
6
7

Parameter models

All PK component functions allow the specification of the parameter model via their arguments. Arguments that refer to a parameter start with the prefix prm_. The default parameter model can be deduced from the default arguments in the usage section of the help entry. The parameter name, specified via the name= argument of the parameter model building block allows the renaming of the model parameters.

For example, the parameter prm_vc= refers to the central volume of distribution parameter in the one compartment distribution PK component and the default parameter model is a log-normal distribution. The following code block specifies a normal distribution parameter model and names the parameter v:

1
2
3
pk_distribution_1cmp(
    prm_vc = prm_normal("v", mean = 50, var = 25)
)

Value

A building block of type 'pk_component'

See Also

pk_model() for the creation of PK models

Other elimination components: pk_elimination_linear_nl(), pk_elimination_linear()


assemblerr documentation built on Jan. 13, 2022, 1:07 a.m.