plot_coefficient_forest

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

plot_coefficient_forest(names: Sequence[str], coefficient: ndarray, lower: ndarray | None = None, upper: ndarray | None = None, *, title: str = 'Coefficients')[source]

Forest-style plot of regression coefficients with optional CIs.

Parameters:

  • names – Covariate names (sanitised).

  • coefficient – Point estimate per covariate.

  • lower – Optional lower confidence bound per covariate.

  • upper – Optional upper confidence bound per covariate.

  • title – Figure title (sanitised).

Returns:

The matplotlib Figure.