Non-Compartmental Analysis for Campsis Simulation Platform

Documentation for package ‘campsisnca’ version 1.7.1

Help Pages

-- A --

abstract_avg_metric-class	Abstract avg metric class.
abstract_last_metric-class	Abstract last metric class.
abstract_max_metric-class	Abstract max metric class.
abstract_min_metric-class	Abstract min metric class.
abstract_time_above_or_below_limit_metric-class	Abstract time above/below limit class.
abstract_value_at_metric-class	Abstract value at metric class.
applyTimeWindow	Apply time window.
apply_time_window	Apply time window.
apply_time_window-method	Apply time window.
AUC	AUC.
auc_metric-class	AUC metric class.
Avg	Avg.
avg_metric-class	Avg metric class.

-- C --

calculate	Calculate.
calculate-method	Calculate.
campsisnca_output	The Campsisnca Output Class Union
campsisnca_output-class	The Campsisnca Output Class Union
campsisnca_tbl	Campsisnca table class (see this class as an interface)
campsisnca_tbl-class	Campsisnca table class (see this class as an interface)
campsis_output	The Campsis Output Class Union
campsis_output-class	The Campsis Output Class Union
CAt	CAt (concentration at specific time).
Cavg	Cavg.
cavg_metric-class	Cavg metric class.
CFB	Alias for Change from Baseline (CFB).
cfb_metric-class	Change from Baseline metric class.
ChangeFromBaseline	Change from Baseline (CFB).
Cmax	Cmax.
cmax_metric-class	Cmax metric class.
Cmin	Cmin
cmin_metric-class	Cmin metric class.
computeTimeAboveBelow	Compute the duration of a line segment above or below a certain limit.
compute_nca_metric_summary	Compute NCA metric summary.
conc_at_metric-class	Concentration at metric class.
Ctrough	Ctrough. Last time in x shall be considered as the trough time. Similar to Last, but for concentrations.
ctrough_metric-class	Ctrough metric class.
CustomMetric	Custom metric (input data as time and value vectors).
CustomMetricTbl	Custom metric (input data as tibble).
custom_metric-class	Custom metric class.
cv	Compute the coefficient of variation.

-- D --

dataframe_type-class	Dataframe export type class.
deparse_digits	Custom deparse function. Works similarly to deparse1. However, lines are trimmed before being concatenated.
deparse_one_line	Deparse 1 line.
discardCategoryColumn	Discard category column.
discard_category_column	Discard category column.

-- E --

export-method	Export replicated NCA table.
extract_brace_values	Extract values from within braces.

-- G --

generate_table_code	Generate table code.
generate_table_code-method	Generate table code.
geocv	Compute the geometric CV.
geomean	Compute the geometric mean.
getCampsisncaOption	Get Campsisnca option logic.
get_character_cols_only	Filter Column Names to Character (and Optionally Factor) Columns
get_default_name	Get default name.
get_default_name-method	Get default name.
get_digits_code	Get digits code for gtsummary.
get_labels_code	Get labels code for gtsummary.
get_latex_name	Get the name of the metric in LaTeX notation (with subscript coded with an underscore and brackets).
get_latex_name-method	Get the name of the metric in LaTeX notation (with subscript coded with an underscore and brackets).
get_statistics_code	Get statistics code for gtsummary.
get_strata	Get all stratas.
get_strata-method	Get all stratas.
get_table_summary_code	Get table summary code.
get_unit	Get the unit corresponding to the given metric.
get_unit-method	Get the unit corresponding to the given metric.
get_variable_type_code	Get the variable type code for gtsummary.
glue_stat_display	Glue stat display string.
gtsummary_type-class	Gt summary export type class.
gt_type-class	Gt export type class.

-- I --

individual_campsisnca_tbl	Individual Campsisnca table class
individual_campsisnca_tbl-class	Individual Campsisnca table class
individual_wide_campsisnca_tbl	Individual (wide format) Campsisnca table class
individual_wide_campsisnca_tbl-class	Individual (wide format) Campsisnca table class
iValue	Compute the individual value of an individual.
i_value	Compute the individual value of an individual.
i_value-method	Compute the individual value of an individual.
i_values	Compute the individual values on a simulation output.
i_values-method	Compute the individual values on a simulation output.
i_value_tbl	Compute the individual value of an individual.
i_value_tbl-method	Compute the individual value of an individual.

-- L --

Last	Last value.
last_metric-class	Last metric class.

-- M --

Max	Max.
max_metric-class	Max metric class.
metrics.1cpt	Theoretical metrics for 1-cpt model results.
metrics.2cpt	Theoretical metrics for 2-cpt model results.
metrics.common	Pre-processing for metrics.1cpt and metrics.2cpt.
Min	Min.
min_metric-class	Min metric class.

-- N --

NCAAnalysis	Create an NCA analysis.
NCAMetrics	NCA metrics
NCAMetricsTable	NCA table (deprecated).
NCAOptions	NCA options used for calculation of metrics.
NCATable	NCA table.
nca_analyses-class	NCA analyses class.
nca_analysis-class	NCA analysis class.
nca_metric-class	NCA metric class. See this class as abstract class.
nca_metrics-class	NCA metrics class. See this class as a list of NCA metrics.
nca_options-class	NCA options class.
nca_table-class	NCA table class.
nca_time_window-class	NCA time window class.

-- P --

pk_bolus_md	Simulated Pharmacokinetic Dataset (Multiple-Dose Bolus)
preserve_column_levels	Preserve Existing Column Value Order as Factor Levels

-- R --

remove_column_levels	Strip Factor Class from Columns
ReplicatedNCATable	Replicated NCA table.
replicated_nca_table-class	Replicated NCA table class.
restore_column_levels	Restore Factor Levels and Optionally Reorder Rows

-- S --

save_column_levels	Extract and Save Column Factor Levels
se	Compute the standard error.
stat_display_string	Return the evaluated statistics display string. This method was kept for backward compatibility in the tests. It is recommended to call 'export(dest="dataframe", type="summary_pretty")' on the NCA table instead.
stat_display_string-method	Return the evaluated statistics display string. This method was kept for backward compatibility in the tests. It is recommended to call 'export(dest="dataframe", type="summary_pretty")' on the NCA table instead.
summary_campsisnca_tbl	Summary Campsisnca table class
summary_campsisnca_tbl-class	Summary Campsisnca table class
summary_pretty_campsisnca_tbl	Summary (pretty format) Campsisnca table class
summary_pretty_campsisnca_tbl-class	Summary (pretty format) Campsisnca table class
summary_wide_campsisnca_tbl	Summary (wide format) Campsisnca table class
summary_wide_campsisnca_tbl-class	Summary (wide format) Campsisnca table class

-- T --

Thalf	Terminal half life computed by making a linear regression in the log domain on the given data x.
Thalf.1cpt	Theoretical half life for a 1-compartment model.
thalf.1cpt.required	Thalf metric required columns for a 1-compartment model.
Thalf.2cpt.dist	Theoretical distribution half life for a 2-compartment model.
Thalf.2cpt.eff	Theoretical effective half life for a 2-compartment model.
thalf.2cpt.required	Thalf metric required columns for a 2-compartment model.
Thalf.2cpt.z	Theoretical elimination half life for a 2-compartment model.
thalf_metric-class	Thalf metric class.
theoretical_thalf_metric-class	Theoretical thalf metric class.
TimeAboveLimit	Time above a certain limit.
TimeBelowLimit	Time below a certain limit.
timerange	Filter CAMPSIS dataset based on min and max time.
TimeWindow	Create a time window object.
time_above_limit_metric-class	Time above limit metric class.
time_below_limit_metric-class	Time below limit metric class.
Tmax	Tmax.
tmax_metric-class	Tmax metric class.
Tmin	Tmin.
tmin_metric-class	Tmin metric class.
toGt	Gtsummary to Gt.
trap	NOTE: This method has been adapted from the 'qpNCA' package by Huisman, Jolling, Mehta and Bergsma (2021) <doi:10.32614/CRAN.package.qpNCA>, following methodology from Rowland and Tozer (2011, ISBN:978-0-683-07404-8).

-- U --

UndefinedNCAOptions	Undefined NCA options.
UndefinedTimeWindow	Create an undefined time window.
undefined_nca_options-class	Undefined NCA options class.
undefined_nca_time_window-class	Undefined NCA time window class.

-- V --

ValueAt	Value at (value at specific time).
value_at_metric-class	Value at metric class.