pkTrans: Change the transformation type for PK models

In nlmixr2lib: A Model Library for 'nlmixr2'

Change the transformation type for PK models

Description

Change the transformation type for PK models

Usage

pkTrans(
  ui,
  type = c("k", "k21", "vss", "aob", "alpha"),
  k13 = "k13",
  k31 = "k31",
  k12 = "k12",
  k21 = "k21",
  kel = "kel",
  vc = "vc",
  cl = "cl",
  vp = "vp",
  q = "q",
  vp2 = "vp2",
  q2 = "q2",
  vss = "vss",
  aob = "aob",
  alpha = "alpha",
  beta = "beta",
  gam = "gam",
  A = "A",
  B = "B",
  C = "C",
  s = "s",
  p = "p",
  tmp = "tmp",
  beforeCmt = c("depot", "central")
)

Arguments

ui	A model in terms of Clearance
type	the type of PK transformation to make: - "k": Change to rate constants (kel, k12, k21, k13, k31) - "vss": Change to volume of distribution at steady state (cl, vc, q, vss) - "aob": Change to A/B ratio (aob, alpha, beta, vc) - "k21": Change to k21 constant (k21, alpha, beta, vc) or (k21, k31, alpha, beta, gam, vc) - "alpha": Change to macro constants (alpha, beta, gam, A, B, C, vc)
k13	name of rate constant from central to periph2
k31	name of rate constant from periph2 to central
k12	name of rate constant from central to periph1
k21	name of rate constant from periph1 to central
kel	name of elimination rate constant
vc	name of central compartment volume
cl	name of clearance
vp	name of volume of periph1
q	name of intercompartmental clearance between central and periph1
vp2	name of volume of periph2
q2	name of intercompartmental clearance between central and periph2
vss	name of volume of distribution at steady state
aob	A/B ratio
alpha	macro constant name for first exponential decay term
beta	macro constant name for second exponential decay term
gam	macro constant name for third exponential decay term
A	macro coefficient for the first exponential decay term (corresponds with alpha)
B	macro coefficient for the second exponential decay term (corresponds with beta)
C	macro coefficient for the third exponential decay term (corresponds with gam)
s	sum constant name for the k12 three compartment
p	product constant name for the k12 three compartment
tmp	name of temporary variable for the three compartment with 'A', 'B', 'C', 'alpha', 'beta' and 'gam'.
beforeCmt	if the model is compartmental you can specify the preferred names where the estimates and extra lines are added before

Value

ui with no PK parameters estimated

Author(s)

Matthew L. Fidler

Examples

# Three compartment model translations

readModelDb("PK_3cmt_des") |>
  pkTrans("k")

readModelDb("PK_3cmt_des") |>
  pkTrans("k21")

readModelDb("PK_3cmt_des") |>
  pkTrans("alpha")

# The most types of transformations are
# available for 2 compartment models

readModelDb("PK_2cmt_des") |>
  pkTrans("k")

readModelDb("PK_2cmt_des") |>
  pkTrans("vss")

readModelDb("PK_2cmt_des") |>
  pkTrans("aob")

readModelDb("PK_2cmt_des") |>
  pkTrans("k21")

readModelDb("PK_2cmt_des") |>
  pkTrans("alpha")

# One compartment transformations are also available:

readModelDb("PK_1cmt_des") |>
  pkTrans("k")

readModelDb("PK_1cmt_des") |>
  pkTrans("alpha")

# also works without depot:

readModelDb("PK_3cmt_des") |>
  removeDepot() |>
  pkTrans("k")

nlmixr2lib documentation built on Oct. 7, 2024, 5:08 p.m.