R/data.R

In xgxr: Exploratory Graphics for Pharmacometrics

#' Multiple Ascending Dose Data Set
#'
#' Model generated PK and PD data to mimic an orally administered small
#' molecule with various endpoints from continuous to ordinal response and
#' count data. Simulated multiple dose administration ranging from 100 mg
#' to 1600 mg, once per day.
#'
#' @format A data frame with the following 19 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab numeric; unique subject ID\cr
#'   column 2: \tab \code{TIME} \tab numeric; time relative to first drug 
#'   administration\cr
#'   column 3: \tab \code{NOMTIME} \tab numeric; nominal time\cr
#'   column 4: \tab \code{TIMEUNIT} \tab character; unit of TIME\cr
#'   column 5: \tab \code{AMT} \tab numeric; dosing amount (for dosing events) 
#'   in mg\cr
#'   column 6: \tab \code{LIDV} \tab numeric; observation on a linear scale 
#'   (observation type determined by CMT), units determined by EVENTU column\cr
#'   column 7: \tab \code{MDV} \tab numeric; missing dependent variable\cr
#'   column 8: \tab \code{CMT} \tab integer; compartment number 
#'   (determines observation type):\cr
#'   \tab \tab CMT 1 = Dosing event\cr
#'   \tab \tab CMT 2 = PK concentration\cr
#'   \tab \tab CMT 3 = Continuous response data\cr
#'   \tab \tab CMT 4 = Count response data\cr
#'   \tab \tab CMT 5 = Ordinal response data\cr
#'   \tab \tab CMT 6 = Binary response data\cr
#'   column 9: \tab \code{NAME} \tab character; description of event\cr
#'   column 10: \tab \code{EVENTU} \tab character; unit for observation\cr
#'   column 11: \tab \code{CENS} \tab integer; censored values
#'   (0 = not censored, 1 = censored)\cr
#'   column 12: \tab \code{EVID} \tab integer; event ID (0 = observation, 
#'   1 = dosing event)\cr
#'   column 13: \tab \code{WEIGHTB} \tab numeric; baseline body weight (kg)\cr
#'   column 14: \tab \code{SEX} \tab character; sex\cr
#'   column 15: \tab \code{TRTACT} \tab factor; treatment group label\cr
#'   column 16: \tab \code{DOSE} \tab numeric; randomized dose in mg\cr
#'   column 17: \tab \code{PROFDAY} \tab numeric; day of profile\cr
#'   column 18: \tab \code{PROFTIME} \tab numeric; time within PROFDAY\cr
#'   column 19: \tab \code{CYCLE} \tab numeric; count of drug administrations 
#'   received
#' }
"mad"

#' Multiple Ascending Dose Data Set (Duplicates Removed)
#'
#' Model generated PK and PD data to mimic an orally administered small
#' molecule with various endpoints from continuous to ordinal response and
#' count data. Simulated multiple dose administration ranging from 100 mg
#' to 1600 mg, once per day.
#'
#' @format A data frame with the following 19 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab numeric; unique subject ID\cr
#'   column 2: \tab \code{TIME} \tab numeric; time relative to first drug 
#'   administration\cr
#'   column 3: \tab \code{NOMTIME} \tab numeric; nominal time\cr
#'   column 4: \tab \code{TIMEUNIT} \tab character; unit of TIME\cr
#'   column 5: \tab \code{AMT} \tab numeric; dosing amount (for dosing events) 
#'   in mg\cr
#'   column 6: \tab \code{LIDV} \tab numeric; observation on a linear scale 
#'   (observation type determined by CMT), units determined by EVENTU column\cr
#'   column 7: \tab \code{MDV} \tab numeric; missing dependent variable\cr
#'   column 8: \tab \code{CMT} \tab integer; compartment number 
#'   (determines observation type):\cr
#'   \tab \tab CMT 1 = Dosing event\cr
#'   \tab \tab CMT 2 = PK concentration\cr
#'   \tab \tab CMT 3 = Continuous response data\cr
#'   \tab \tab CMT 4 = Count response data\cr
#'   \tab \tab CMT 5 = Ordinal response data\cr
#'   \tab \tab CMT 6 = Binary response data\cr
#'   column 9: \tab \code{NAME} \tab character; description of event\cr
#'   column 10: \tab \code{EVENTU} \tab character; unit for observation\cr
#'   column 11: \tab \code{CENS} \tab integer; censored values
#'   (0 = not censored, 1 = censored)\cr
#'   column 12: \tab \code{EVID} \tab integer; event ID (0 = observation, 
#'   1 = dosing event)\cr
#'   column 13: \tab \code{WEIGHTB} \tab numeric; baseline body weight (kg)\cr
#'   column 14: \tab \code{SEX} \tab character; sex\cr
#'   column 15: \tab \code{TRTACT} \tab factor; treatment group label\cr
#'   column 16: \tab \code{DOSE} \tab numeric; randomized dose in mg\cr
#'   column 17: \tab \code{PROFDAY} \tab numeric; day of profile\cr
#'   column 18: \tab \code{PROFTIME} \tab numeric; time within PROFDAY\cr
#'   column 19: \tab \code{CYCLE} \tab numeric; count of drug administrations 
#'   received
#' }
"mad_missing_duplicates"

#' Multiple Ascending Dose Noncompartmental Analysis (NCA) dataset
#' @format A data frame with the following 7 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab numeric; unique subject ID\cr
#'   column 2: \tab \code{PARAM} \tab character; NCA parameter\cr
#'   column 3: \tab \code{VALUE} \tab numeric; Value of the NCA parameter\cr
#'   column 4: \tab \code{DOSE} \tab numeric; randomized dose in mg\cr
#'   column 15: \tab \code{TRTACT} \tab factor; treatment group label\cr
#'   column 14: \tab \code{SEX} \tab character; sex\cr
#'   column 13: \tab \code{WEIGHTB} \tab numeric; baseline body weight (kg)
#' }
"mad_nca"

#' Case 1 PKPD Data Set
#' @format A data frame with the following 21 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab integer; unique subject ID\cr
#'   column 2: \tab \code{TIME} \tab numeric; time relative to first drug 
#'   administration\cr
#'   column 3: \tab \code{NOMTIME} \tab numeric; nominal time\cr
#'   column 4: \tab \code{TIMEUNIT} \tab factor; unit of TIME\cr
#'   column 5: \tab \code{AMT} \tab integer; dosing amount (for dosing events) 
#'   in mg\cr
#'   column 6: \tab \code{LIDV} \tab numeric; observation on a linear scale 
#'   (observation type determined by CMT), units determined by EVENTU column\cr
#'   column 7: \tab \code{CMT} \tab integer; compartment number 
#'   (determines observation type):\cr
#'   \tab \tab CMT 1 = Dosing event\cr
#'   \tab \tab CMT 2 = PK concentration\cr
#'   \tab \tab CMT 3 = Continuous response data\cr
#'   \tab \tab CMT 4 = Count response data\cr
#'   \tab \tab CMT 5 = Ordinal response data\cr
#'   \tab \tab CMT 6 = Binary response data\cr
#'   column 8: \tab \code{NAME} \tab factor; description of event\cr
#'   column 9: \tab \code{EVENTU} \tab factor; unit for observation\cr
#'   column 10: \tab \code{CENS} \tab integer; censored values
#'   (0 = not censored, 1 = censored)\cr
#'   column 11: \tab \code{EVID} \tab integer; event ID (0 = observation, 
#'   1 = dosing event)\cr
#'   column 12: \tab \code{WEIGHTB} \tab numeric; baseline body weight (kg)\cr
#'   column 13: \tab \code{eff0} \tab numeric; efficacy\cr
#'   column 14: \tab \code{TRTACT} \tab factor; treatment group label\cr
#'   column 15: \tab \code{DOSE} \tab integer; Dose in mg\cr
#'   column 16: \tab \code{PROFDAY} \tab integer; day of profile\cr
#'   column 17: \tab \code{PROFTIME} \tab numeric; time within PROFDAY\cr
#'   column 18: \tab \code{CYCLE} \tab integer; count of drug administrations
#'   received\cr
#'   column 19: \tab \code{PART} \tab integer; part of study\cr
#'   column 20: \tab \code{STUDY} \tab integer; study\cr
#'   column 21: \tab \code{IPRED} \tab numeric; individual prediction\cr
#' }
"case1_pkpd"

#' nlmixr Theophylline SD Data Set
#'
#' Theophylline dataset, from the nlmixr R package
#'
#' @format A data frame with the following 7 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab integer; unique patient identifier\cr
#'   column 2: \tab \code{TIME} \tab numeric; time relative to first drug 
#'   administration\cr
#'   column 3: \tab \code{DV} \tab numeric; dependent variable (drug concentration) \cr
#'   column 4: \tab \code{AMT} \tab numeric; dose of drug \cr
#'   column 5: \tab \code{EVID} \tab integer; event ID, 1 if dose, 0 otherwise\cr
#'   column 6: \tab \code{CMT} \tab integer; compartment number\cr
#'   column 7: \tab \code{WT} \tab numeric; weight
#' }
"nlmixr_theo_sd"

#' Single Ascending Dose Data Set
#'
#' Model generated PK data to mimic an orally administered small molecule.
#' Simulated single dose administration ranging from 100 mg to 1600 mg.
#'
#' @format A data frame with the following 16 columns:
#' \tabular{rll}{
#'   column 1: \tab \code{ID} \tab numeric; unique subject ID\cr
#'   column 2: \tab \code{TIME} \tab numeric; time relative to first drug 
#'   administration\cr
#'   column 3: \tab \code{NOMTIME} \tab numeric; nominal time\cr
#'   column 4: \tab \code{TIMEUNIT} \tab character; unit of TIME\cr
#'   column 5: \tab \code{AMT} \tab numeric; dosing amount (for dosing events) 
#'   in mg\cr
#'   column 6: \tab \code{LIDV} \tab numeric; observation on a linear scale 
#'   (observation type determined by CMT), units determined by EVENTU column\cr
#'   column 7: \tab \code{MDV} \tab numeric; missing dependent variable \cr
#'   (1 if missing, 0 otherwise)\cr
#'   column 8: \tab \code{CMT} \tab integer; compartment number 
#'   (determines observation type):\cr
#'   \tab \tab CMT 1 = Dosing event\cr
#'   \tab \tab CMT 2 = PK concentration\cr
#'   column 9: \tab \code{NAME} \tab character; description of event\cr
#'   column 10: \tab \code{EVENTU} \tab character; unit for observation\cr
#'   column 11: \tab \code{CENS} \tab integer; censored values
#'   (0 = not censored, 1 = censored)\cr
#'   column 12: \tab \code{EVID} \tab integer; event ID (0 = observation, 
#'   1 = dosing event)\cr
#'   column 13: \tab \code{WEIGHTB} \tab numeric; baseline body weight (kg)\cr
#'   column 14: \tab \code{SEX} \tab character; sex\cr
#'   column 15: \tab \code{TRTACT} \tab factor; treatment group label\cr
#'   column 16: \tab \code{DOSE} \tab numeric; randomized dose in mg 
#'   received
#' }
"sad"