Skip to contents

PKNCA provides functions to complete noncompartmental analysis (NCA) for pharmacokinetic (PK) data. Its intent is to provide a complete R-based solution enabling data provenance for NCA. This will include the tracking of data cleaning, enabling of calculations, exporting of results, and general reporting. The library is designed to give a reasonable answer without user intervention (load, calculate, and summarize), but it allows the user to override the automatic selections at any point.

The library design is modular to allow expansion based on needs unforeseen by the authors including new NCA parameters, novel data cleaning methods, and modular summarization decisions. Expanding the library will be discussed in a separate vignette.

Quick Start

The simplest analysis requires concentration data at a minimum; adding dosing data enables automatic interval determination and dose-dependent parameters (without dosing data, intervals must be provided to PKNCAdata()). Given concentration and dosing data, it then takes five function calls to provide summarized results. (This example runs as-is; a few later examples in this document– the grouping and manual-interval sketches– only illustrate the workflow without running. For another complete example, please see the theophylline example.)

library(PKNCA)
library(dplyr, quietly = TRUE)
## 
## Attaching package: 'dplyr'
## The following objects are masked from 'package:stats':
## 
##     filter, lag
## The following objects are masked from 'package:base':
## 
##     intersect, setdiff, setequal, union
## Load the PK concentration data
d_conc <- as.data.frame(datasets::Theoph)
## Generate the dosing data
d_dose <- d_conc[d_conc$Time == 0,]

## Create a concentration object specifying the concentration, time, and
## subject columns.  (Note that any number of grouping levels is
## supported; you are not restricted to just grouping by subject.)
o_conc <-
  PKNCAconc(
    d_conc,
    conc~Time|Subject
  )
## Create a dosing object specifying the dose, time, and subject
## columns.  (Note that the grouping factors should be the same as or a
## subset of the grouping factors for concentration, and the grouping
## columns must have the same names between concentration and dose
## objects.)
o_dose <-
  PKNCAdose(
    d_dose,
    Dose~Time|Subject
  )
## Combine the concentration and dosing information both to
## automatically define the intervals for NCA calculation and provide
## doses for calculations requiring dose.
o_data <- PKNCAdata(o_conc, o_dose)

## Calculate the NCA parameters
o_nca <- pk.nca(o_data)

## Summarize the results
summary(o_nca)
##  start end  N     auclast        cmax               tmax                 tlag
##      0 Inf 12 98.7 [22.5] 8.65 [17.0] 1.14 [0.630, 3.55] 0.000 [0.000, 0.000]
##         count_conc   half.life aucinf.obs aucpext.obs        cl.obs
##  11.0 [11.0, 11.0] 8.18 [2.12] 115 [28.4] 13.8 [6.34] 0.0398 [29.4]
## 
## Caption: auclast, cmax, aucinf.obs, cl.obs: geometric mean and geometric coefficient of variation; tmax, tlag, count_conc: median and range; half.life, aucpext.obs: arithmetic mean and standard deviation; N: number of subjects

Note that PKNCAdose() also accepts a route argument ("extravascular" or "intravascular"); when it is not given, extravascular administration is assumed.

Data Handling

After loading data, it must be in the right form. The minimum requirements are that concentration, dose, and time must all be numeric (and not factors). Grouping variables have no specific requirements; they can be any mode.

Values below the limit of quantification are coded as zeros (0), and missing values are coded as NA. If the limit of quantification itself is available, it can be given with the lloq argument to PKNCAconc() (a value or a column name), and it is carried through to the censored-likelihood (Tobit) half-life method (hl_method = "tobit"); see the Tobit half-life vignette for details.

Units may be assigned when creating the input objects with the unit arguments to PKNCAconc() and PKNCAdose() (concu, timeu, amountu, doseu, and their *_pref counterparts for automatic conversion). When units are given, a units table is automatically created during PKNCAdata() construction so that calculated parameters carry their units. See the unit assignment and conversion vignette for details.

Options: Make PKNCA Work Your Way

Calculation Options: the PKNCA.options Function

Different organizations have different requirements for computation and summarization of NCA. Options for how to perform calculations and summaries are handled by the PKNCA.options command.

Default options have been set to commonly-used standard parameters. The current value for options can be found by running the command with no arguments:

## $adj.r.squared.factor
## [1] 1e-04
## 
## $r.squared.factor
## [1] NA
## 
## $max.missing
## [1] 0.5
## 
## $auc.method
## [1] "lin up/log down"
## 
## $conc.na
## [1] "drop"
## 
## $conc.blq
## $conc.blq$first
## [1] "keep"
## 
## $conc.blq$middle
## [1] "drop"
## 
## $conc.blq$last
## [1] "keep"
## 
## 
## $debug
## NULL
## 
## $first.tmax
## [1] TRUE
## 
## $first.tmin
## [1] TRUE
## 
## $allow.tmax.in.half.life
## [1] FALSE
## 
## $keep_interval_cols
## NULL
## 
## $min.hl.points
## [1] 3
## 
## $min.span.ratio
## [1] 2
## 
## $max.aucinf.pext
## [1] 20
## 
## $min.hl.r.squared
## [1] 0.9
## 
## $progress
## [1] TRUE
## 
## $tau.choices
## [1] NA
## 
## $auto.interval.method
## [1] "builder"
## 
## $auto.interval.tolerance
## [1] 0.05
## 
## $single.dose.aucs
##   start end auclast auclast_se auclast_df aucall aumclast aumclast_se
## 1     0  24    TRUE      FALSE      FALSE  FALSE    FALSE       FALSE
## 2     0 Inf   FALSE      FALSE      FALSE  FALSE    FALSE       FALSE
##   aumclast_df aumcall aucint.last aucint.all aumcint.last aumcint.all    c0
## 1       FALSE   FALSE       FALSE      FALSE        FALSE       FALSE FALSE
## 2       FALSE   FALSE       FALSE      FALSE        FALSE       FALSE FALSE
##    cmax  cmin  tmax  tmin tlast tfirst clast.obs cl.last cl.all cl.int.all
## 1 FALSE FALSE FALSE FALSE FALSE  FALSE     FALSE   FALSE  FALSE      FALSE
## 2  TRUE FALSE  TRUE FALSE FALSE  FALSE     FALSE   FALSE  FALSE      FALSE
##   cl.int.last mrt.last mrt.all mrt.int.all mrt.int.last mrt.iv.last vss.last
## 1       FALSE    FALSE   FALSE       FALSE        FALSE       FALSE    FALSE
## 2       FALSE    FALSE   FALSE       FALSE        FALSE       FALSE    FALSE
##   vss.iv.last vss.all vss.int.all vss.int.last   cav cav.int.last cav.int.all
## 1       FALSE   FALSE       FALSE        FALSE FALSE        FALSE       FALSE
## 2       FALSE   FALSE       FALSE        FALSE FALSE        FALSE       FALSE
##   ctrough cstart   ptr  tlag deg.fluc swing  ceoi aucabove.predose.all
## 1   FALSE  FALSE FALSE FALSE    FALSE FALSE FALSE                FALSE
## 2   FALSE  FALSE FALSE FALSE    FALSE FALSE FALSE                FALSE
##   aucabove.trough.all count_conc count_conc_measured totdose volpk    ae
## 1               FALSE      FALSE               FALSE   FALSE FALSE FALSE
## 2               FALSE      FALSE               FALSE   FALSE FALSE FALSE
##   clr.last clr.obs clr.pred    fe ertlst ermax ertmax erint erlst ratio.cmax
## 1    FALSE   FALSE    FALSE FALSE  FALSE FALSE  FALSE FALSE FALSE      FALSE
## 2    FALSE   FALSE    FALSE FALSE  FALSE FALSE  FALSE FALSE FALSE      FALSE
##   ratio.auclast ratio.aucint.last ratio.aucint.all sparse_auclast sparse_auc_se
## 1         FALSE             FALSE            FALSE          FALSE         FALSE
## 2         FALSE             FALSE            FALSE          FALSE         FALSE
##   sparse_auc_df sparse_aumclast sparse_aumc_se sparse_aumc_df time_above
## 1         FALSE           FALSE          FALSE          FALSE      FALSE
## 2         FALSE           FALSE          FALSE          FALSE      FALSE
##   aucivlast aucivall aucivint.last aucivint.all aucivpbextlast aucivpbextall
## 1     FALSE    FALSE         FALSE        FALSE          FALSE         FALSE
## 2     FALSE    FALSE         FALSE        FALSE          FALSE         FALSE
##   aucivpbextint.last aucivpbextint.all aumcivlast aumcivall aumcivint.last
## 1              FALSE             FALSE      FALSE     FALSE          FALSE
## 2              FALSE             FALSE      FALSE     FALSE          FALSE
##   aumcivint.all half.life r.squared adj.r.squared lambda.z.corrxy lambda.z
## 1         FALSE     FALSE     FALSE         FALSE           FALSE    FALSE
## 2         FALSE      TRUE     FALSE         FALSE           FALSE    FALSE
##   lambda.z.time.first lambda.z.time.last lambda.z.n.points clast.pred
## 1               FALSE              FALSE             FALSE      FALSE
## 2               FALSE              FALSE             FALSE      FALSE
##   span.ratio tobit_residual adj_tobit_residual lambda.z.n.points_blq
## 1      FALSE          FALSE              FALSE                 FALSE
## 2      FALSE          FALSE              FALSE                 FALSE
##   thalf.eff.last thalf.eff.iv.last kel.last kel.iv.last kel.all kel.int.all
## 1          FALSE             FALSE    FALSE       FALSE   FALSE       FALSE
## 2          FALSE             FALSE    FALSE       FALSE   FALSE       FALSE
##   kel.int.last cl.iv.all cl.iv.last cl.ivint.all cl.ivint.last cl.sparse.last
## 1        FALSE     FALSE      FALSE        FALSE         FALSE          FALSE
## 2        FALSE     FALSE      FALSE        FALSE         FALSE          FALSE
##   f.last f.int.last f.int.all mrt.sparse.last mrt.iv.all mrt.ivint.all
## 1  FALSE      FALSE     FALSE           FALSE      FALSE         FALSE
## 2  FALSE      FALSE     FALSE           FALSE      FALSE         FALSE
##   mrt.ivint.last vz.all vz.int.all vz.int.last vz.iv.all vz.iv.last
## 1          FALSE  FALSE      FALSE       FALSE     FALSE      FALSE
## 2          FALSE  FALSE      FALSE       FALSE     FALSE      FALSE
##   vz.ivint.all vz.ivint.last vz.last vss.iv.all vss.ivint.all vss.ivint.last
## 1        FALSE         FALSE   FALSE      FALSE         FALSE          FALSE
## 2        FALSE         FALSE   FALSE      FALSE         FALSE          FALSE
##   vss.sparse.last aucinf.obs aucinf.pred aumcinf.obs aumcinf.pred
## 1           FALSE      FALSE       FALSE       FALSE        FALSE
## 2           FALSE       TRUE       FALSE       FALSE        FALSE
##   aucint.inf.obs aucint.inf.pred aumcint.inf.obs aumcint.inf.pred aucivinf.obs
## 1          FALSE           FALSE           FALSE            FALSE        FALSE
## 2          FALSE           FALSE           FALSE            FALSE        FALSE
##   aucivinf.pred aucivpbextinf.obs aucivpbextinf.pred aumcivinf.obs
## 1         FALSE             FALSE              FALSE         FALSE
## 2         FALSE             FALSE              FALSE         FALSE
##   aumcivinf.pred aucpext.obs aucpext.pred kel.iv.all kel.ivint.all
## 1          FALSE       FALSE        FALSE      FALSE         FALSE
## 2          FALSE       FALSE        FALSE      FALSE         FALSE
##   kel.ivint.last kel.sparse.last cl.obs cl.pred cl.int.inf.obs cl.int.inf.pred
## 1          FALSE           FALSE  FALSE   FALSE          FALSE           FALSE
## 2          FALSE           FALSE  FALSE   FALSE          FALSE           FALSE
##   cl.iv.obs cl.iv.pred f.obs f.pred f.int.obs f.int.pred mrt.obs mrt.pred
## 1     FALSE      FALSE FALSE  FALSE     FALSE      FALSE   FALSE    FALSE
## 2     FALSE      FALSE FALSE  FALSE     FALSE      FALSE   FALSE    FALSE
##   mrt.int.inf.obs mrt.int.inf.pred mrt.iv.obs mrt.iv.pred mrt.md.obs
## 1           FALSE            FALSE      FALSE       FALSE      FALSE
## 2           FALSE            FALSE      FALSE       FALSE      FALSE
##   mrt.md.pred mrt.ivmd.obs mrt.ivmd.pred vz.obs vz.pred vz.int.inf.obs
## 1       FALSE        FALSE         FALSE  FALSE   FALSE          FALSE
## 2       FALSE        FALSE         FALSE  FALSE   FALSE          FALSE
##   vz.int.inf.pred vz.iv.obs vz.iv.pred vz.sparse.last vss.obs vss.pred
## 1           FALSE     FALSE      FALSE          FALSE   FALSE    FALSE
## 2           FALSE     FALSE      FALSE          FALSE   FALSE    FALSE
##   vss.iv.obs vss.iv.pred vss.md.obs vss.md.pred vss.ivmd.obs vss.ivmd.pred
## 1      FALSE       FALSE      FALSE       FALSE        FALSE         FALSE
## 2      FALSE       FALSE      FALSE       FALSE        FALSE         FALSE
##   vss.int.inf.obs vss.int.inf.pred cav.int.inf.obs cav.int.inf.pred
## 1           FALSE            FALSE           FALSE            FALSE
## 2           FALSE            FALSE           FALSE            FALSE
##   ratio.aucinf.obs ratio.aucinf.pred thalf.eff.obs thalf.eff.pred
## 1            FALSE             FALSE         FALSE          FALSE
## 2            FALSE             FALSE         FALSE          FALSE
##   thalf.eff.iv.obs thalf.eff.iv.pred kel.obs kel.pred kel.iv.obs kel.iv.pred
## 1            FALSE             FALSE   FALSE    FALSE      FALSE       FALSE
## 2            FALSE             FALSE   FALSE    FALSE      FALSE       FALSE
##   kel.int.inf.obs kel.int.inf.pred auclast.dn aucall.dn aucinf.obs.dn
## 1           FALSE            FALSE      FALSE     FALSE         FALSE
## 2           FALSE            FALSE      FALSE     FALSE         FALSE
##   aucinf.pred.dn aumclast.dn aumcall.dn aumcinf.obs.dn aumcinf.pred.dn cmax.dn
## 1          FALSE       FALSE      FALSE          FALSE           FALSE   FALSE
## 2          FALSE       FALSE      FALSE          FALSE           FALSE   FALSE
##   cmin.dn clast.obs.dn clast.pred.dn cav.dn ctrough.dn clr.last.dn clr.obs.dn
## 1   FALSE        FALSE         FALSE  FALSE      FALSE       FALSE      FALSE
## 2   FALSE        FALSE         FALSE  FALSE      FALSE       FALSE      FALSE
##   clr.pred.dn
## 1       FALSE
## 2       FALSE
## 
## $allow_partial_missing_units
## [1] FALSE
## 
## $hl_method
## [1] "log-linear"
## 
## $tobit_n_points_penalty
## [1] 0
## 
## $tobit_optim_control
## list()

And, to reset the current values to the library defaults, run the function with the default argument set to TRUE.

PKNCA.options(default = TRUE)

Each of the options is documented where it is used; for example, the first.tmax option is documented in the pk.calc.tmax function.

Summarization Options: the PKNCA.set.summary Function

On top of methods of calculation, summarization method preferences differ. Typical summarization preferences include selection of the measurement of central tendency and dispersion, handling of missing values, handling of values below the limit of quantification, and more. Beyond the method for summarization, presentation is managed through user preferences. Presentation is typically controlled by rounding to either a defined number of decimal places or significant figures.

An example is that Cmax may be summarized by the geometric mean with the geometric CV using three significant figures, and having a summary result requires that at least half of the available values are present (not missing). The code below will set this example.

PKNCA.set.summary(
  name = "cmax",
  description = "geometric mean and geometric coefficient of variation",
  point = business.geomean,
  spread = business.geocv,
  rounding = list(signif = 3)
)

Another example is that Tmax is usually summarized by the median and range, and as measurements are often taken with minute resolution and recorded in hours, reporting is usually to the second decimal place.

PKNCA.set.summary(
  name = "tmax",
  description = "median and range",
  point = business.median,
  spread = business.range,
  rounding = list(round = 2)
)

If the functions or default rounding options provided in the library do not meet the summarization needs, a user-supplied function can be used for rounding.

median_na <- function(x) {
  median(x, na.rm = TRUE)
}
quantprob_na <- function(x) {
  quantile(x, probs = c(0.05, 0.95), na.rm = TRUE)
}
PKNCA.set.summary(
  name = "auclast",
  description = "median and 5th to 95th percentile",
  point = median_na,
  spread = quantprob_na,
  rounding = list(signif = 3)
)

In some cases multiple parameters may need the same summary functions (as often occurs with simulated data). Many parameters can be set simultaneously by specifying a vector of names.

median_na <- function(x) {
  median(x, na.rm = TRUE)
}
quantprob_na <- function(x) {
  quantile(x, probs = c(0.05, 0.95), na.rm = TRUE)
}
PKNCA.set.summary(
  name = c("auclast", "cmax", "tmax", "half.life", "aucinf.pred"),
  description = "median and 5th to 95th percentile",
  point = median_na,
  spread = quantprob_na,
  rounding = list(signif = 3)
)

Grouping NCA Data

As described in the quick start, concentration and dose data are generally grouped to identify how to separate the data. Typical groups for concentration data include study, treatment, subject, and analyte. Typical groups for dose data include study, treatment, and subject. By default, summaries are produced based on the concentration groups dropping the subject (so that averages are taken across subjects within the other parameters).

The quick start example can be extended to include multiple analytes as follows. The only difference is the /analyte formula element in the concentration data. The reason for the slash instead of the plus is that the last element before a slash is assumed to be the subject, and as noted before, the subject is (by default) excluded from the summary grouping (so that summaries are grouped by study, treatment, etc., but not by subject).

## Generate a faux multi-study, multi-analyte dataset.
d_conc_parent <- d_conc
d_conc_parent$Subject <- as.numeric(as.character(d_conc_parent$Subject))
d_conc_parent$Study <- d_conc_parent$Subject <= 6
d_conc_parent$Analyte <- "Parent"
d_conc_metabolite <- d_conc_parent
d_conc_metabolite$conc <- d_conc_metabolite$conc/2
d_conc_metabolite$Analyte <- "Metabolite"
d_conc_both <- rbind(d_conc_parent, d_conc_metabolite)
d_conc_both <- d_conc_both[with(d_conc_both, order(Study, Subject, Time, Analyte)),]
d_dose_both <- d_conc_both[d_conc_both$Time == 0 & d_conc_both$Analyte %in% "Parent",
                           c("Study", "Subject", "Dose", "Time")]

## Create a concentration object specifying the concentration, time,
## study, and subject columns.  (Note that any number of grouping
## levels is supported; you are not restricted to this list.)
o_conc <- PKNCAconc(d_conc_both, conc~Time|Study+Subject/Analyte)
## Create a dosing object specifying the dose, time, study, and
## subject columns.  (Note that the grouping factors should be a
## subset of the grouping factors for concentration, and the columns
## must have the same names between concentration and dose objects.)
o_dose <- PKNCAdose(d_dose_both, Dose~Time|Study+Subject)

# Perform and summarize the PK data as previously described
o_data <- PKNCAdata(o_conc, o_dose)
o_nca <- pk.nca(o_data)
summary(o_nca)

Selecting Calculation Intervals

All NCA calculations require the interval over which they are calculated. When the concentration and dosing information are combined to the PKNCAdata object, intervals are automatically determined. The exception to this automatic determination is if the user provides intervals.

When selected either automatically or manually, intervals define at minimum a start time, an end time, and the parameters to be calculated. The parameter list is available from the get.interval.cols function. The parameters requested are specified by setting the entry in a data.frame as requested.

intervals <-
  data.frame(
    start=0, end=c(24, Inf),
    cmax=c(FALSE, TRUE),
    tmax=c(FALSE, TRUE),
    auclast=TRUE,
    aucinf.obs=c(FALSE, TRUE)
  )

Intervals like the one above are sufficient for designs with a single type of treatment– such as single doses. For more complex treatments in a single analysis, like the combination of single and multiple doses, include a treatment column matching the treatment column name from the concentration data set. See the Manual Interval Specification section below for more details.

Selection of Data Used for Calculation

When choosing which data is used for a calculation, PKNCA will never look beyond the data specified in the group and interval. Groups are defined by the call to the PKNCAconc function, and they will typically define the measurement of a single analyte from a single individual receiving a single treatment. Intervals are subsets within a group by start and end time. PKNCA never examines data outside of the group and interval for standard NCA calculations. As an example, with data from 0 to 48 hours and an interval set to start at 0 and end at 24 with the calculation of aucinf.obs, any data after 24 hours will not be used for the half-life or AUCinf calculations.

A few functions look at data outside of a single interval, but these functions do not look at data outside of a single group, and these functions are typically used during preparation for NCA calculations not for the calculations themselves. Functions that look at a group as a whole include choose.auc.intervals, find.tau, and pk.tss.

Automatic Interval Determination

If intervals are not specified when combining the concentration and dosing data, they will automatically be found from the concentration and dosing data.

Single dose data has a simple interval selection: the option single.dose.aucs is used from the PKNCA.options.

start end auclast auclast_se auclast_df aucall aumclast aumclast_se aumclast_df aumcall aucint.last aucint.all aumcint.last aumcint.all c0 cmax cmin tmax tmin tlast tfirst clast.obs cl.last cl.all cl.int.all cl.int.last mrt.last mrt.all mrt.int.all mrt.int.last mrt.iv.last vss.last vss.iv.last vss.all vss.int.all vss.int.last cav cav.int.last cav.int.all ctrough cstart ptr tlag deg.fluc swing ceoi aucabove.predose.all aucabove.trough.all count_conc count_conc_measured totdose volpk ae clr.last clr.obs clr.pred fe ertlst ermax ertmax erint erlst ratio.cmax ratio.auclast ratio.aucint.last ratio.aucint.all sparse_auclast sparse_auc_se sparse_auc_df sparse_aumclast sparse_aumc_se sparse_aumc_df time_above aucivlast aucivall aucivint.last aucivint.all aucivpbextlast aucivpbextall aucivpbextint.last aucivpbextint.all aumcivlast aumcivall aumcivint.last aumcivint.all half.life r.squared adj.r.squared lambda.z.corrxy lambda.z lambda.z.time.first lambda.z.time.last lambda.z.n.points clast.pred span.ratio tobit_residual adj_tobit_residual lambda.z.n.points_blq thalf.eff.last thalf.eff.iv.last kel.last kel.iv.last kel.all kel.int.all kel.int.last cl.iv.all cl.iv.last cl.ivint.all cl.ivint.last cl.sparse.last f.last f.int.last f.int.all mrt.sparse.last mrt.iv.all mrt.ivint.all mrt.ivint.last vz.all vz.int.all vz.int.last vz.iv.all vz.iv.last vz.ivint.all vz.ivint.last vz.last vss.iv.all vss.ivint.all vss.ivint.last vss.sparse.last aucinf.obs aucinf.pred aumcinf.obs aumcinf.pred aucint.inf.obs aucint.inf.pred aumcint.inf.obs aumcint.inf.pred aucivinf.obs aucivinf.pred aucivpbextinf.obs aucivpbextinf.pred aumcivinf.obs aumcivinf.pred aucpext.obs aucpext.pred kel.iv.all kel.ivint.all kel.ivint.last kel.sparse.last cl.obs cl.pred cl.int.inf.obs cl.int.inf.pred cl.iv.obs cl.iv.pred f.obs f.pred f.int.obs f.int.pred mrt.obs mrt.pred mrt.int.inf.obs mrt.int.inf.pred mrt.iv.obs mrt.iv.pred mrt.md.obs mrt.md.pred mrt.ivmd.obs mrt.ivmd.pred vz.obs vz.pred vz.int.inf.obs vz.int.inf.pred vz.iv.obs vz.iv.pred vz.sparse.last vss.obs vss.pred vss.iv.obs vss.iv.pred vss.md.obs vss.md.pred vss.ivmd.obs vss.ivmd.pred vss.int.inf.obs vss.int.inf.pred cav.int.inf.obs cav.int.inf.pred ratio.aucinf.obs ratio.aucinf.pred thalf.eff.obs thalf.eff.pred thalf.eff.iv.obs thalf.eff.iv.pred kel.obs kel.pred kel.iv.obs kel.iv.pred kel.int.inf.obs kel.int.inf.pred auclast.dn aucall.dn aucinf.obs.dn aucinf.pred.dn aumclast.dn aumcall.dn aumcinf.obs.dn aumcinf.pred.dn cmax.dn cmin.dn clast.obs.dn clast.pred.dn cav.dn ctrough.dn clr.last.dn clr.obs.dn clr.pred.dn
0 24 TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE
0 Inf FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE

For multiple-dose studies, PKNCA selects one group at a time and compares the concentration and dosing times. When there is a concentration measurement between doses, an interval row is added. The dosing interval (τ\tau) is determined by looking for pattern repeats within the dosing data using the find.tau function.

## find.tau can work when all doses have the same interval...
dose_times <- seq(0, 168, by=24)
print(dose_times)
## [1]   0  24  48  72  96 120 144 168
PKNCA::find.tau(dose_times)
## [1] 24
## or when the doses have mixed intervals (10 and 24 hours).
dose_times <- sort(c(seq(0, 168, by=24),
                     seq(10, 178, by=24)))
print(dose_times)
##  [1]   0  10  24  34  48  58  72  82  96 106 120 130 144 154 168 178
PKNCA::find.tau(dose_times)
## [1] 24

After finding τ\tau, PKNCA will also look after the last dose (or the beginning of the last dosing interval), and two additional intervals may be added:

  • one interval for the dosing interval after the beginning of the last dosing interval (if there are concentrations measured in the interval)
  • one interval for the half-life after the last dosing interval (if there are concentration more than τ\tau after the beginning of the last interval).

One consequence of automatic interval selection is that many rows are generated for intervals; one row is generated per interval per subject. The benefit of the method producing a large number of rows is that it is fully flexible to the actual study results. If a subject has a different schedule than the others for the same treatment (e.g. measurements that were nominally scheduled for day 14 occurred on day 13), those differences will be found.

Manual Interval Specification

Intervals can also be specified manually. Two use cases are common for manual specification: fully manual (never requesting the automatic intervals) and updating the automatic intervals.

Fully manual intervals can be specified by providing it to the PKNCAdata call.

intervals_manual <-
  data.frame(
    start=0, end=c(24, Inf),
    cmax=c(FALSE, TRUE),
    tmax=c(FALSE, TRUE),
    auclast=TRUE,
    aucinf.obs=c(FALSE, TRUE)
  )
o_data <-
  PKNCAdata(
    o_conc, o_dose, 
    intervals=intervals_manual
  )

To update the automatically-selected intervals, extract the intervals, modify them, and put them back.

o_data <- PKNCAdata(o_conc, o_dose)
intervals_manual <- o_data$intervals
intervals_manual$aucinf.obs[1] <- TRUE
o_data$intervals <- intervals_manual

Keeping a column from intervals

When computing NCA using actual times, grouping by start and end time in summaries (see later) is less helpful because everyone could have different start and end times. So, you may keep the interval columns using the option "keep_interval_cols" as follows (where “dosetype” must be a column name in the intervals):

o_data <- PKNCAdata(o_conc, o_dose, options = list(keep_interval_cols = "dosetype"))

Summarizing results

When NCA has been calculated, you can summarize the results with the summary() function, and the row-level (individual) results are available with as.data.frame() (which can also generate CDISC PP-style output with as.data.frame(o_nca, out_format = "cdisc")).

summary(o_nca)

By default, it will count the number of unique subjects (N) in the summary, and when the number of subjects differs from the number of measurements included in a summary (n), it will summarize n for the given parameters. Note that counting of “n” includes all non-missing values that were not excluded from summarization; this will include all zeros that are e.g. excluded from geometric statistics.

Edge cases like two unique subjects where one has an excluded value and one has duplicated values (N = 2 and n = 2 even though both measurements come from a single subject) are to be handled by the user.

Updating existing results

Updating existing results is most helpful if you are writing a shiny or other user interface for PKNCA. If you are using PKNCA from a script, this is not the preferred way to perform analysis.

If you need to rerun analyses with minor updates– changing half-life point selection, for instance– you can use update() on a PKNCAresults object (o_nca in the example above). Using update() will recalculate the minimum-required number of calculations for the data that are changed. Only changes to the concentration or dose data are recalculated selectively; any other change (for example, to the intervals or options) triggers a full recalculation with a warning.

To use update(), give it your existing results and the new PKNCAdata object you want to use.

Starting from the theophylline example in the Quick Start section above:

d_conc <- as.data.frame(datasets::Theoph)
d_dose <- d_conc[d_conc$Time == 0,]
o_conc <- PKNCAconc(d_conc, conc~Time|Subject)
o_dose <- PKNCAdose(d_dose, Dose~Time|Subject)
o_data <- PKNCAdata(o_conc, o_dose)
o_nca <- pk.nca(o_data)
summary(o_nca)
##  start end  N     auclast        cmax               tmax                 tlag
##      0 Inf 12 98.7 [22.5] 8.65 [17.0] 1.14 [0.630, 3.55] 0.000 [0.000, 0.000]
##         count_conc   half.life aucinf.obs aucpext.obs        cl.obs
##  11.0 [11.0, 11.0] 8.18 [2.12] 115 [28.4] 13.8 [6.34] 0.0398 [29.4]
## 
## Caption: auclast, cmax, aucinf.obs, cl.obs: geometric mean and geometric coefficient of variation; tmax, tlag, count_conc: median and range; half.life, aucpext.obs: arithmetic mean and standard deviation; N: number of subjects

In these data, some participants have a nonzero predose concentration. Assume that we want to manually change those concentrations to zero and then recalculate. You can change the concentration data, and use update() to recalculate only for the changed participants.

d_conc_setzero <- as.data.frame(datasets::Theoph)
d_conc_setzero$conc[d_conc$Time == 0] <- 0
o_conc_update <- PKNCAconc(d_conc_setzero, conc~Time|Subject)
o_data_update <- PKNCAdata(o_conc_update, o_dose)
o_nca_update <- update(o_nca, o_data_update)
summary(o_nca_update)
##  start end  N     auclast        cmax               tmax                 tlag
##      0 Inf 12 98.6 [22.5] 8.65 [17.0] 1.14 [0.630, 3.55] 0.000 [0.000, 0.000]
##         count_conc   half.life aucinf.obs aucpext.obs        cl.obs
##  11.0 [11.0, 11.0] 8.18 [2.12] 115 [28.4] 13.8 [6.34] 0.0398 [29.3]
## 
## Caption: auclast, cmax, aucinf.obs, cl.obs: geometric mean and geometric coefficient of variation; tmax, tlag, count_conc: median and range; half.life, aucpext.obs: arithmetic mean and standard deviation; N: number of subjects

Only the participants whose concentration data changed are recalculated; results for all other participants are carried over unchanged.

Now, assume that instead of calculating auclast from time 0 to 24, we want to calculate aucint.inf.obs. We can change the intervals to create a new PKNCAdata object:

d_intervals <- o_data$intervals
d_intervals$aucint.inf.obs <- d_intervals$auclast
d_intervals$auclast <- FALSE
o_data_update <- PKNCAdata(o_conc, o_dose, intervals = d_intervals)

Then, we can update the PKNCAresults:

o_nca_update <- update(o_nca, o_data_update)
## Warning: Full recalculation: changes detected in data other than source
## concentration or dose data
summary(o_nca_update)
##  start end  N        cmax               tmax                 tlag
##      0 Inf 12 8.65 [17.0] 1.14 [0.630, 3.55] 0.000 [0.000, 0.000]
##         count_conc   half.life aucinf.obs aucint.inf.obs aucpext.obs
##  11.0 [11.0, 11.0] 8.18 [2.12] 115 [28.4]     115 [28.4] 13.8 [6.34]
##         cl.obs
##  0.0398 [29.4]
## 
## Caption: cmax, aucinf.obs, aucint.inf.obs, cl.obs: geometric mean and geometric coefficient of variation; tmax, tlag, count_conc: median and range; half.life, aucpext.obs: arithmetic mean and standard deviation; N: number of subjects