Skip to content

Commit

Permalink
Fix documentation forestplot
Browse files Browse the repository at this point in the history
In the forestplot the central points are the median not the mean. At least, this is what it seems from the code of forest plot.
Furthermore, I have fixed a typo in the formula
  • Loading branch information
davideC00 authored Sep 23, 2024
1 parent eb692cb commit 0588979
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions arviz/plots/forestplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ def plot_forest(
Specify the kind of plot:
* The ``kind="forestplot"`` generates credible intervals, where the central points are the
estimated posterior means, the thick lines are the central quartiles, and the thin lines
represent the :math:`100\times`(`hdi_prob`)% highest density intervals.
estimated posterior median, the thick lines are the central quartiles, and the thin lines
represent the :math:`100\times(hdi\_prob)\%` highest density intervals.
* The ``kind="ridgeplot"`` option generates density plots (kernel density estimate or
histograms) in the same graph. Ridge plots can be configured to have different overlap,
truncation bounds and quantile markers.
Expand Down

0 comments on commit 0588979

Please sign in to comment.