tablePopulationParameterEstimates()

Returns a reporting-ready table of Monolix population parameter estimates including fixed effects, inter-individual (IIV) and inter-occasion (IOV) variability, correlations, and residual error, together with their uncertainties. Supports long or wide layouts; optional RSE, confidence-interval, CV%, per-category fixed-effect, and bootstrap columns; and custom aliases/units/descriptions. The output carries attributes used by style_tfl() to auto-generate section headers.

Usage

tablePopulationParameterEstimates(projectFile        = NULL,
                                  customAliases      = NULL,
                                  customUnits        = NULL,
                                  customDescriptions = NULL,
                                  includeRSE         = TRUE,
                                  includeIIV         = TRUE,
                                  includeIOV         = TRUE,
                                  includeCI          = FALSE,
                                  includeCV          = FALSE,
                                  includeFEcategory  = FALSE,
                                  includeBootstrap   = FALSE,
                                  useWideFormat      = FALSE,
                                  stdErrMethod       = "",
                                  roundDigits        = 3,
                                  roundMethod        = c("monolixSuiteRounding", "significantFigures", "significantFiguresPreserved", "none"),
                                  prettyLabels       = TRUE,
                                  mock               = FALSE)

Arguments

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

• customAliases (character / data.frame) Named vector or 2-column data frame mapping parameter names → custom display labels, e.g. c(ka_pop = "Absorption Rate", V_pop = "Volume"). Parameters not in the mapping keep their original names (with the _pop suffix removed). Supports [[sub:…]], [[sup:…]], ~italic~ formatting.

• customUnits (character / data.frame) Named vector or 2-column data frame mapping parameter names → custom unit labels, e.g. c(ka_pop = "1/h", V_pop = "L", Cl_pop = "L/h"). Units are appended in parentheses, e.g. "Volume (L)".

• customDescriptions (character / data.frame) Named vector or 2-column data frame mapping parameter names → descriptive text, e.g. c(Cl_pop = "Apparent clearance"). Added as a separate Description column to the right of Parameter (the Parameter value is unchanged); unmatched parameters get NA. Keys must match raw Monolix names (e.g. Cl_pop, omega_Cl, gamma_Cl, a, b). In wide format, descriptions for omega_* / gamma_* keys are not displayed (a message lists the unmatched keys).

• includeRSE (logical) If TRUE (default), includes relative standard error (RSE) columns. Applies to both fixed and random effects in wide format.

• includeIIV (logical) If TRUE (default), includes inter-individual variability (IIV) omega estimates in wide format. When FALSE, only fixed-effect estimates are shown in wide format (CV% can still appear if includeCV = TRUE).

• includeIOV (logical) If TRUE (default), includes inter-occasion variability (IOV) gamma parameters. When FALSE, IOV parameters are excluded.

• includeCI (logical) If TRUE, includes confidence-interval columns formatted as "(lower; upper)". Default FALSE. The percentile bounds in the column name follow the project's standard-error interval-level setting (e.g. CI_2.5_97.5 for 95%, CI_5_95 for 90%). Applies to both fixed and random effects in wide format.

• includeCV (logical) If TRUE, includes coefficient of variation (CV%) for random effects. Default FALSE. In wide format, CV% appears as an additional column alongside omega estimates when includeIIV = TRUE.

• includeFEcategory (logical) If TRUE, includes separate rows for fixed-effect values by categorical covariate level (the per-category estimates Monolix exposes via the withValuesByGroups option). Each per-category row has Section = "FE_CAT" and is grouped immediately after its parent fixed-effect rows. Default FALSE.

• includeBootstrap (logical) If TRUE, includes bootstrap results: median estimate, confidence interval (e.g. Boot_CI_2.5_97.5), and RSE (if available). Bootstrap CI levels adapt to project settings (90%, 95%, 99%). Default FALSE. Requires a bootstrap analysis to have been run in Monolix.

• useWideFormat (logical) If TRUE, presents random effects (IIV/IOV) in wide format with omega estimates as columns next to their corresponding fixed effects (sections: Fixed effects | Random effects, plus separate headers for Correlations and Residual error). If FALSE (default), uses long format where each parameter appears in its own row.

• stdErrMethod (character) Standard-error method to use. Options: "" (default — uses whichever method the project has, preferring linear if both are available), "linear", or "stochasticApproximation".

• roundDigits (integer) Number of digits to display (default 3). Interpretation depends on roundMethod.

• roundMethod (character) How numeric values are rounded:

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

• prettyLabels (logical) If TRUE (default), applies pretty column names with newlines for better display (e.g. "Fixed Effect\nEstimate", "IIV\nSD"). If FALSE, uses simpler names without newlines (e.g. "FE_Estimate", "IIV_SD").

• mock (logical) If TRUE, masks values for documentation/examples: every estimate/uncertainty column (Estimate/FE_Estimate, RSE, CV, the CI_* / IIV_* / IOV_* / Boot_* columns, in both layouts) becomes a placeholder (e.g. "xx.xx"; CI intervals become "(xx.xx; xx.xx)"). Section, Parameter, and Description are kept. Default FALSE.

Examples

See also

style_tfl

Last updated: October 09, 2026