Summary Functions

birdman.summary.summarize_posterior(posterior: Dataset, data_var: str, coords: Optional[dict] = None, estimator: str = 'mean') → Union[DataFrame, Series]

Summarize posterior distribution to pandas.

Parameters

• posterior (xr.Dataset) – Posterior distribution of estimated parameters

• data_var (str) – Data variable to summarize

• coords (dict) – Mapping of entries in dims to labels

• estimator (str) – How to summarize posterior, one of ‘mean’, ‘median’, or ‘std’

Returns

Summarized posterior according to estimator

Return type

pd.DataFrame or pd.Series