SummarisedResult
= None , settings= None )Container for a summarised result (results table + settings table).
Mirrors the omopgenerics summarised_result class. Provides methods for filtering, splitting, tidying, suppressing, and combining results.
Methods
add_settings Add or update columns in the settings table.
additional_columns Return unique additional_name values (excluding ‘overall’).
combine_strata Combine multiple strata columns into a single compound strata.
filter_additional Filter results by additional_name/additional_level pairs.
filter_group Filter results by group_name/group_level pairs.
filter_settings Filter results by settings column values.
filter_strata Filter results by strata_name/strata_level pairs.
group_columns Return unique group_name values (excluding ‘overall’).
is_result_suppressed Check if this result has been suppressed.
pivot_estimates Pivot estimate_name into columns with estimate_value as values.
settings_columns Return non-standard settings column names.
split_additional Split additional_name/additional_level into separate columns.
split_all Split all dimensions (group, strata, additional) into separate columns.
split_group Split group_name/group_level into separate columns.
split_strata Split strata_name/strata_level into separate columns.
strata_columns Return unique strata_name values (excluding ‘overall’).
suppress Suppress results below the minimum cell count.
tidy Convert to tidy (wide) format.
tidy_columns Return the column names that would appear after tidy().
unite_additional Recombine individual additional columns back into additional_name/additional_level.
unite_group Recombine individual group columns back into group_name/group_level.
unite_strata Recombine individual strata columns back into strata_name/strata_level.
add_settings
** kwargs)Add or update columns in the settings table.
Parameters
**kwargs
str
Column name / value pairs to add to settings.
{}
additional_columns
Return unique additional_name values (excluding ‘overall’).
combine_strata
* columns)Combine multiple strata columns into a single compound strata.
Parameters
*columns
str
Column names to combine into strata.
()
filter_additional
** kwargs)Filter results by additional_name/additional_level pairs.
Parameters
**kwargs
Any
Pairs where key is the additional_name value and value is the additional_level value(s) to keep.
{}
filter_group
** kwargs)Filter results by group_name/group_level pairs.
Parameters
**kwargs
Any
Pairs where key is the group_name value and value is the group_level value(s) to keep.
{}
filter_settings
** kwargs)Filter results by settings column values.
Parameters
**kwargs
Any
Column name / value pairs to filter the settings table by. Values can be a single value or a list of values.
{}
Returns
SummarisedResult
Filtered result.
filter_strata
** kwargs)Filter results by strata_name/strata_level pairs.
Parameters
**kwargs
Any
Pairs where key is the strata_name value and value is the strata_level value(s) to keep.
{}
group_columns
Return unique group_name values (excluding ‘overall’).
is_result_suppressed
Check if this result has been suppressed.
Returns
bool
True if min_cell_count setting is > 0.
pivot_estimates
Pivot estimate_name into columns with estimate_value as values.
Similar to tidy() but does not split dimensions or merge settings.
settings_columns
Return non-standard settings column names.
split_additional
Split additional_name/additional_level into separate columns.
split_all
Split all dimensions (group, strata, additional) into separate columns.
split_group
Split group_name/group_level into separate columns.
Returns
pandas.DataFrame
Results with group_name/group_level replaced by individual columns.
split_strata
Split strata_name/strata_level into separate columns.
strata_columns
Return unique strata_name values (excluding ‘overall’).
suppress
= 5 )Suppress results below the minimum cell count.
Replaces estimate_value with NA for numeric estimates where the count is below min_cell_count, and obscures the exact count.
Parameters
min_cell_count
int
Minimum cell count threshold (default 5).
5
tidy
Convert to tidy (wide) format.
Splits all dimensions and pivots estimate_name into columns with values from estimate_value.
tidy_columns
Return the column names that would appear after tidy().
unite_additional
Recombine individual additional columns back into additional_name/additional_level.
unite_group
Recombine individual group columns back into group_name/group_level.
Reverses the effect of split_group. Finds columns that were produced by splitting and re-merges them into the group_name / group_level compound format.
unite_strata
Recombine individual strata columns back into strata_name/strata_level.