listingNCARatios()

Produces a subject-level listing of individual NCA ratio parameter values from a PKanalix project, one row per subject, with the selected (or all) ratio parameters as columns. Supports covariate stratification/sorting, covariate/ID filtering, per-parameter rounding, and custom aliases.

Usage

listingNCARatios(projectFile      = NULL,
                 splitCovariates  = NULL,
                 selectParameters = NULL,
                 filterCovariates = NULL,
                 filterIds        = NULL,
                 roundDigits      = 3,
                 roundMethod      = c("monolixSuiteRounding", "significantFigures", "significantFiguresPreserved", "none"),
                 roundByParameter = NULL,
                 aliases          = TRUE,
                 customAliases    = NULL,
                 mock             = FALSE)

Arguments

• projectFile (character) Path to a PKanalix project file (.pkx). If NULL (default), uses the currently loaded project.

• splitCovariates (character) Categorical covariates (type "catcov") to include and sort by. If specified, the table is sorted by these covariates in the order provided, placed to the left of id. Occasion-varying covariates are rejected, since ratios are computed across occasions and cannot be stratified by a within-subject-varying covariate. If NULL (default), none are added (occasion-invariant stratification-only / additional-stratification categorical covariates defined in the project are still merged in automatically).

• selectParameters (character) Ratio parameters to include. If NULL (default), all available ratio parameters are included.

• filterCovariates (list) Named list of categorical covariates → allowed values, e.g. list(SEX = "Male", DOSE = c("100","200")). Non-matching rows are dropped. If NULL (default), no covariate filtering is applied.

• filterIds (character/numeric) Subject IDs to include. If NULL (default), no ID filtering is applied.

• roundDigits (integer) Number of decimal places for rounding (default 3).

• roundMethod (character) How numeric values are rounded. roundDigits controls the number of digits in each case. Options:

  • "monolixSuiteRounding" (default) - Mirrors MonolixSuite display. The integer part is kept exactly as-is, and only the fractional part is rounded to roundDigits significant figures. Small values (< 1) automatically get more decimal places.

  • "significantFigures" - Standard significant-figures rounding: the value is rounded to roundDigits total significant digits, zeroing non-significant digits before the decimal for large numbers.

  • "significantFiguresPreserved" - Like "significantFigures", but never zeroes digits before the decimal. Once the integer part already has at least roundDigits digits, the value is simply rounded to the nearest whole number instead of being zeroed out.

  • "none" - No rounding; values are returned as-is.

• roundByParameter Optional per-parameter rounding overrides on top of the global settings, either a named numeric vector of digits (c(Cmax_ratio = 2, AUClast_ratio = 4)) or a 3-column data frame (parameter, digits, method). Unlisted parameters keep global settings (default NULL).

• aliases (logical) If TRUE (default), parameter names are replaced with their aliases.

• customAliases (character / data.frame) Named vector or 2-column data frame mapping parameters → custom alias labels, e.g. c(Cmax_ratio = "C[[sub:max]] ratio"). Overrides project aliases. Supports [[sub:…]], [[sup:…]], ~italic~.

• mock (logical) If TRUE, masks values for documentation/examples: id → "id1", categorical / stratification covariates → "Category 1", and all numeric columns (continuous covariates, ratio parameter values) → "xx.xx". Default FALSE.

Examples

Last updated: October 09, 2026