system_nca_summary {ubiquity} | R Documentation |
Summarize NCA Results in Tabular Format
Description
Creates tabular summaries of NCA results
Usage
system_nca_summary(
cfg,
analysis_name = "analysis",
treat_as_factor = c("ID", "Dose_Number", "Dose"),
params_include = c("ID", "cmax", "tmax", "auclast"),
params_header = NULL,
rptname = "default",
label_format = NULL,
summary_stats = NULL,
summary_labels = list(MEAN = "Mean", STD = "Std Dev", MEDIAN = "Median", N = "N obs",
SE = "Std Err."),
summary_location = NULL,
ds_wrangle = NULL,
digits = 3,
table_theme = "theme_zebra"
)
Arguments
cfg |
ubiquity system object |
analysis_name |
string containing the name of the analysis (default |
treat_as_factor |
sequence of column names to be treated as factors (default |
params_include |
vector with names of parameters to include (default c("ID", "cmax", "tmax", "auclast")) |
params_header |
list with names of parameters followed by a vector of headers. You can use the placeholder "<label>" to include the standard label (e.g. list(cmax=c("<label>", "(ng/ml)"))), with a default of |
rptname |
report name (either PowerPoint or Word) that this table will be used in ( |
label_format |
string containing the format in which headers and labels are being specified, either |
summary_stats |
list with strings as names containing placeholders for
summary statistics and the values indicate the parameters to apply those
statistics to. for example, if you want to calculate mean and standard deviation of
AUClast you could use |
summary_labels |
list containing the mapping of summary statistics
defined by list(MEAN = "Mean", STD = "Std Dev", MEDIAN = "Median", N = "N obs", SE = "Std Err.") |
summary_location |
column where to put the labels (e.g. Mean (Std)) for
summary statistic. The default ( |
ds_wrangle |
ds_wrangle = list(Dose=c(30), Dose_Number = c(1)) |
digits |
number of significant digits to report (3) or |
table_theme |
flextable theme see the flextable package for available themes, and set to |
Value
list with the following elements
isgood Boolean variable indicating success (
TRUE
) or failure (FALSE
) if the call is successful the following will be defined (NULL
nca_summary dataframe containing the summary table with headers and any summary statistics appended to the bottom
nca_summary_ft same information in the
nca_summary
ouput as a flextable objectcomponents list with the elements of the summary table each as dataframes (header, data, and summary)
See Also
Vignette on NCA (vignette("NCA", package = "ubiquity")
)