summary.PKNCAresults: Summarize PKNCA results

In 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,
  summarize.n.per.group = TRUE,
  not.requested.string = ".",
  not.calculated.string = "NC",
  pretty_names = NULL
)

Arguments

object	The results to summarize
...	Ignored.
drop.group	Which group(s) should be dropped from the formula?
summarize.n.per.group	Should a column for N be added (TRUE or FALSE)? 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.string	A character string to use when a parameter summary was not requested for a parameter within an interval.
not.calculated.string	A character string to use when a parameter summary was requested, but the point estimate AND spread calculations (if applicable) returned NA.
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 an 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.string="NA")

PKNCA documentation built on April 30, 2023, 1:08 a.m.