table_characteristics

table_characteristics(
    result,
    *,
    header=None,
    group_column=None,
    hide=None,
    estimate_format=None,
)

Format a summarise_characteristics (or summarise_cohort_count) result into a table.

Pivots estimate_name/estimate_value so each estimate is a column, and optionally selects/orders columns for display.

Parameters

Name	Type	Description	Default
result	SummarisedResult (with .results and .settings) or DataFrame of results.		required
header	Columns to show first (e.g. ["cdm_name", "group_level"]). Default	[“cdm_name”, “group_level”, “strata_level”, “variable_name”, “variable_level”].	None
group_column	Extra grouping columns to keep.		None
hide	Column names to drop from output.		None
estimate_format	Optional mapping from estimate_name to display format	(e.g. {“count”: “N”, “percentage”: “%”}). Applied to column names after pivot.	None

Returns

Name	Type	Description
	pandas.DataFrame	Formatted table with one row per (group, strata, variable) and columns for each estimate.