Skip to contents

Table specification for parameter tables

Usage

TableSpec(
  title = "Model Parameters",
  parameter_names = ParameterNameOptions(),
  columns = NULL,
  add_columns = NULL,
  drop_columns = NULL,
  hide_empty_columns = TRUE,
  sections = section_rules(),
  section_filter = NULL,
  row_filter = filter_rules(),
  display_transforms = list(),
  variability_rules = default_variability_rules(),
  n_sigfig = 3,
  ci = CIOptions(),
  n_decimals_ofv = 3,
  pvalue_scientific = FALSE,
  pvalue_threshold = NULL,
  missing_text = "",
  missing_apply_to = "all",
  footnote_order = c("summary_info", "equations", "abbreviations")
)

Arguments

title

Character. Title for the parameter table header. Default is "Model Parameters".

parameter_names

ParameterNameOptions object controlling how parameter names are displayed. Controls which name field to use ("name", "display", or "nonmem") and whether to append theta info to omega names. Defaults to ParameterNameOptions().

columns

Character vector of columns to include in output.

add_columns

Character vector of columns to append to the column list. Useful for comparisons when you want to add columns like "pct_change" without overriding columns.

drop_columns

Character vector of columns to exclude from output, or NULL (default) to include all columns.

hide_empty_columns

Logical. If TRUE, columns that are all NA/empty are automatically hidden unless explicitly requested via columns or add_columns. Default is TRUE.

sections

Section rules created with section_rules().

section_filter

Character vector of section labels to exclude from the table. Use NA to also exclude rows that don't match any section rule. Default is NULL (no filtering). See set_spec_section_filter().

row_filter

Filter rules created with filter_rules().

display_transforms

Named list specifying which transforms to apply for display. Names are parameter kinds (theta, omega, sigma), values are which columns to transform ("all", "estimate", "cv", "rse", "ci", "symbol").

variability_rules

Rules created with variability_rules() to define the variability display column. Default uses built-in formatting.

n_sigfig

Number of significant figures for numeric formatting in the output table. Must be a positive integer. Default is 3.

ci

CIOptions object controlling CI merge behavior and missing-value display. Defaults to CIOptions().

n_decimals_ofv

Number of decimal places for OFV values in summary footnotes. Use NA to keep significant-figure formatting. Default is 3

pvalue_scientific

Logical. If TRUE, p-values are formatted in scientific notation. 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).

missing_text

Text to substitute for NA values after formatting. Default is "".

missing_apply_to

Which columns to apply missing text to: "all", "numeric", or "character". Default is "all".

footnote_order

Character vector controlling the order of footnote sections, or NULL to disable footnotes. Valid values: "summary_info", "equations", "abbreviations". Default is c("summary_info", "equations", "abbreviations").