DecompositionPlots.channel_share_hdi

DecompositionPlots.channel_share_hdi(hdi_prob=0.94, idata=None, dims=None, figsize=None, backend=None, return_as_pc=False, **pc_kwargs)

Forest plot of each channel’s share of total channel contribution.

Computes each channel’s contribution as a fraction of total channel contribution (summed over dates), then plots the HDI for each channel.

Parameters:

hdi_probfloat, default 0.94

HDI probability mass.

idataaz.InferenceData, optional

Override instance data for this call only.

dimsdict[str, Any], optional

Subset dimensions, e.g. {"geo": ["CA"]}.

figsizetuple[float, float], optional

Injected into figure_kwargs.

backendstr, optional

Rendering backend. Non-matplotlib requires return_as_pc=True.

return_as_pcbool, default False

If True, return the PlotCollection.

**pc_kwargs

Forwarded to azp.plot_forest().

Returns:

tuple[Figure, NDArray[Axes]] or PlotCollection