summary.PKNCAresults: Summarize PKNCA results

In billdenney/pknca: Perform Pharmacokinetic Non-Compartmental Analysis

Summarize PKNCA results

Description

Summarize PKNCA results

Usage

## S3 method for class 'PKNCAresults'
summary(
  object,
  ...,
  drop_group = object$data$conc$columns$subject,
  drop_param = character(),
  summarize_n = NA,
  not_requested = ".",
  not_calculated = "NC",
  drop.group = deprecated(),
  summarize.n.per.group = deprecated(),
  not.requested.string = deprecated(),
  not.calculated.string = deprecated(),
  pretty_names = NULL
)

Arguments

object	The results to summarize
...	Ignored.
drop_group	Which group(s) should be dropped from the formula?
drop_param	Which parameters should be excluded from the summary?
summarize_n	Should a column for N be added (TRUE or FALSE)? NA means to automatically detect adding N if the data has a subject column indicated. Note that N is maximum number of parameter results for any parameter; if no parameters are requested for a group, then N will be NA.
not_requested	A character string to use when a parameter summary was not requested for a parameter within an interval.
not_calculated	A character string to use when a parameter summary was requested, but the point estimate AND spread calculations (if applicable) returned NA.
drop.group, summarize.n.per.group, not.requested.string, not.calculated.string	Deprecated use drop_group, not_requested, not_calculated, or summarize_n, instead
pretty_names	Should pretty names (easier to understand in a report) be used? TRUE is yes, FALSE is no, and NULL is yes if units are used and no if units are not used.

Details

Excluded results will not be included in the summary.

Value

A data frame of NCA parameter results summarized according to the summarization settings.

See Also

PKNCA.set.summary(), print.summary_PKNCAresults()

Examples

conc_obj <- PKNCAconc(as.data.frame(datasets::Theoph), conc ~ Time | Subject)
d_dose <-
  unique(datasets::Theoph[
    datasets::Theoph$Time == 0,
    c("Dose", "Time", "Subject")
  ])
dose_obj <- PKNCAdose(d_dose, Dose ~ Time | Subject)
data_obj_automatic <- PKNCAdata(conc_obj, dose_obj)
results_obj_automatic <- pk.nca(data_obj_automatic)
# To get standard results run summary
summary(results_obj_automatic)
# To enable numeric conversion and extraction, do not give a spread function
# and subsequently run as.numeric on the result columns.
PKNCA.set.summary(
  name = c("auclast", "cmax", "half.life", "aucinf.obs"),
  point = business.geomean,
  description = "geometric mean"
)
PKNCA.set.summary(
  name = c("tmax"),
  point = business.median,
  description = "median"
)
summary(results_obj_automatic, not_requested = "NA")

billdenney/pknca documentation built on April 1, 2024, 10:45 p.m.