format_estimate_name

format_estimate_name(
    result,
    estimate_name=None,
    keep_not_formatted=True,
    use_format_order=True,
)

Combine estimate_name and estimate_value into new labels.

estimate_name maps display label -> format string with placeholders, e.g. {“N (%)”: “ ()”, “N”: “”}.

Parameters

Name	Type	Description	Default
result	DataFrame	Must contain estimate_name, estimate_value (and estimate_type).	required
estimate_name	dict	Display name -> format template using placeholders.	`None`
keep_not_formatted	bool	If False, drop rows that didn’t match any template.	`True`
use_format_order	bool	Sort output by the order of keys in estimate_name.	`True`

Name	Type	Description
	DataFrame