tableRunHistory()

Produces a reporting-ready summary table of the Monolix run history from a Sycomore project, model-selection criteria (OFV/log-likelihood and BICc), parent relationships, deltas to the parent run, ratings, and comments. Supports sorting by criterion, criterion filtering, and run masking for examples.

Usage

tableRunHistory(sycomoreProjectFile,
                roundDigits    = 2,
                roundMethod    = c("monolixSuiteRounding", "significantFigures", "significantFiguresPreserved", "none"),
                sortByCriteria = c("LL", "BICc", "none"),
                filterCriteria = c("none", "LL", "BICc"),
                prettyLabels   = TRUE,
                mock           = FALSE)

Arguments

• sycomoreProjectFile (character) Path to a Sycomore project file (.syc). Mandatory (no default). The project must contain a defined model-tree graph, the run hierarchy and parent/child relationships are read from it, and deltas to the parent run depend on it.

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

• sortByCriteria (character) Which criterion to sort by:

  • "LL" (default) - sort by log-likelihood/OFV (lowest first = best model)

  • "BICc" - sort by BICc (lowest first = best model)

  • "none" - no sorting

  When both linearization and importance-sampling results are available, the method is auto-detected from the parent project.

• filterCriteria (character) Which criteria columns to display:

  • "none" (default) - show all criteria columns (LL and BICc)

  • "LL" - show only LL columns (removes BICc columns)

  • "BICc" - show only BICc columns (removes LL columns)

  When sorting by a criterion, filterCriteria must be "none" or match the sort criterion (e.g. sortByCriteria = "LL" with filterCriteria = "BICc" is an error).

• prettyLabels (logical) If TRUE (default), applies human-readable column labels (e.g. "LL (Imp. Sampling)" instead of "LLis").

• mock (logical) If TRUE, masks values for documentation/examples: the LL/BICc/delta columns become placeholders (e.g. "xx.xx"); Comments is blanked; Rating is masked (numeric → "xx.xx", non-numeric blanked); and Run/Parent (which hold real project/file names that may embed study, compound, or company identifiers) are relabeled generically ("project01", "project02"…) via one consistent mapping, so a Parent reference always matches the generic name of that project's own Run row. Path is rebuilt from the relabeled name (keeping only the file extension). Default FALSE.

Returns: A data frame with Run (project/run name); Parent (parent run name, empty for root projects); LLlin/LLis (log-likelihood from linearization / importance sampling); BICclin/BICcis (BICc from each method); dLLlin/dLLis and dBICclin/dBICcis (deltas vs the parent run); Comments (from the mlxtran file); and Rating (user rating from Sycomore). Columns that are all NA are automatically removed.

Examples

Last updated: October 09, 2026