Summary specification for run summary tables

Usage

SummarySpec(
  title = "Run Summary",
  models_to_include = NULL,
  tag_filter = NULL,
  tag_exclude = NULL,
  summary_filter = summary_filter_rules(),
  remove_unrun_models = TRUE,
  columns = NULL,
  add_columns = NULL,
  drop_columns = NULL,
  hide_empty_columns = TRUE,
  n_sigfig = 3,
  n_decimals_ofv = 3,
  time_format = "seconds",
  pvalue_scientific = FALSE,
  pvalue_threshold = NULL,
  sections = section_rules(),
  section_filter = NULL,
  footnote_order = "abbreviations"
)

Arguments

title: Character. Title for the table header. Default is "Run Summary".
models_to_include: Character vector of model names to include in the table (with or without .mod/.ctl extensions), or NULL (default).
tag_filter: Character vector of tags, or NULL (default). Only models with at least one matching tag are included.
tag_exclude: Character vector of tags to exclude, or NULL (default). Models with any matching tag are removed. Applied after tag_filter.
summary_filter: Filter rules created with summary_filter_rules().
remove_unrun_models: Logical. If TRUE (default), models without completed runs are excluded from the table.
columns: Character vector of columns to include. Valid columns: "based_on", "description", "n_parameters", "problem", "number_data_records", "number_subjects", "number_obs", "estimation_method", "estimation_time", "covariance_time", "postprocess_time", "function_evaluations", "significant_digits", "ofv", "dofv", "condition_number", "termination_status", "pvalue", "df". Note: "pvalue" and "df" require "dofv" to be calculated; pvalue uses the Likelihood Ratio Test (LRT) assuming nested models.
add_columns: Character vector of columns to append to the default columns list, or NULL (default).
drop_columns: Character vector of columns to exclude from output, or NULL (default).
hide_empty_columns: Logical. If TRUE, columns with all NA values are hidden. Default is TRUE.
n_sigfig: Number of significant figures for numeric formatting. Default is 3.
n_decimals_ofv: Number of decimal places for OFV and dOFV values. Default is 3.
time_format: Format for time columns. Options: "seconds" (default), "minutes", "hours", "auto" (auto-scale based on magnitude).
pvalue_scientific: Logical. If TRUE, p-values are formatted in scientific notation (e.g., 1.23e-04). If FALSE (default), uses significant figures from n_sigfig.
pvalue_threshold: Numeric or NULL. If set, p-values below this threshold are displayed as "< threshold" (e.g., "< 0.05"). Default is NULL (no threshold).
sections: Section rules created with section_rules().
section_filter: Character vector of section labels to exclude from the table. Use NA to also exclude models that don't match any section rule. Default is NULL (no filtering). See set_spec_section_filter().
footnote_order: Character vector controlling the order of footnote sections, or NULL to disable footnotes. Valid value for SummarySpec: "abbreviations". Default is c("abbreviations").