MonolixSuite in R
Auto Light Dark
MonolixSuite in R
Auto Light Dark
Breadcrumbs

listingNCAConcentration()

Produces a long-format subject-level listing of individual NCA concentrations by time from a PKanalix project, one row per subject/time point, joined with the used-concentration data (which points entered the lambda-z calculation) and censoring flags. Supports stratification/occasion columns, optional nominal time, and covariate/ID filtering.

Usage

R
listingNCAConcentration(projectFile      = NULL,
                        splitCovariates  = NULL,
                        useNominalTime   = FALSE,
                        filterCovariates = NULL,
                        filterIds        = NULL,
                        roundDigits      = 3,
                        roundMethod      = c("none", "monolixSuiteRounding", "significantFigures", "significantFiguresPreserved"),
                        mock             = FALSE)

Arguments

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

  • splitCovariates (character) Covariate name(s) to include as stratification columns, e.g. c("TREAT","FOOD"). If NULL (default), no stratification. Occasion columns present in the project are appended automatically (and concatenated into the subject ID with sep = "#" to keep IDs unique).

  • useNominalTime (logical) If TRUE, attempts to use nominal time for the listing; if nominal time is unavailable in the project, falls back to actual time and issues a warning. Default is FALSE. (Actual time is always extracted so the listing can join with the lambda-z point data.)

  • 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.

  • mock (logical) If TRUE, masks values for documentation/examples: id → "id1", categorical covariates / occasions → "Category 1" / "occ1", and all numeric columns (time, Concentration, UsedConc, Censoring) → "xx.xx". Default FALSE.

Examples


Last updated: