init_pkmod {tci} | R Documentation |
Create an object with class "pkmod"
Description
Create an object with class "pkmod"
Usage
init_pkmod(
pars_pk = NULL,
init = NULL,
pkfn = NULL,
pars_pd = NULL,
pdfn = NULL,
pdinv = NULL,
pcmpt = NULL,
ecmpt = NULL,
sigma_add = NULL,
sigma_mult = NULL,
log_response = NULL,
Omega = NULL
)
Arguments
pars_pk |
Vector or matrix of named PK parameters. If not specified, the pkmod function will be inferred from the parameter names. Print 'list_parnms()' for acceptable parameter names. |
init |
Vector of initial concentrations. Will default to values of zero in all compartments if not specified. |
pkfn |
PK model function. Functions provided in 'tci' include 'pkmod1cpt', 'pkmod2cpt', 'pkmod3cpt', and 'pkmod3cptm'. User-defined functions should be specified here. |
pars_pd |
PD model parameters if a PD model is specified |
pdfn |
PD model function |
pdinv |
Inverse PD model function for use in TCI algorithms |
pcmpt |
Index of plasma compartment. Defaults to first compartment if not specified. |
ecmpt |
Index of effect-site compartment if a PD model is specified. Will default to last compartment if unspecified. |
sigma_add |
Standard deviation of additive residual error |
sigma_mult |
Standard deviation of multiplicative residual error |
log_response |
Logical value indicating if the response should be logged prior to adding error. |
Omega |
Optional matrix of random effect parameters. Column names should correspond to names of pars_pk, pars_pd, and sigma_add or sigma_mult. |
Value
A list with class pkmod for which print, plot, predict, and simulate methods exist.
Examples
# create a pkmod object for a one compartment model with plasma targeting
init_pkmod()