Skip to content

DOC: explain behavior of notches beyond quartiles #6703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2016
Merged

DOC: explain behavior of notches beyond quartiles #6703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3098,7 +3098,19 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,

notch : bool, optional (False)
If `True`, will produce a notched box plot. Otherwise, a
rectangular boxplot is produced.
rectangular boxplot is produced. The notches represent the
confidence interval (CI) around the median. See the entry
for the ``bootstrap`` parameter for information regarding
how the locations of the notches are computed.

.. note::

In cases where the values of the CI are less than the
lower quartile or greater than the upper quartile, the
notches will extend beyond the box, giving it a
distinctive "flipped" appearance. This is expected
behavior and consistent with other statistical
visualization packages.

sym : str, optional
The default symbol for flier points. Enter an empty string
Expand All @@ -3124,13 +3136,13 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,

bootstrap : int, optional
Specifies whether to bootstrap the confidence intervals
around the median for notched boxplots. If `bootstrap` is None,
no bootstrapping is performed, and notches are calculated
using a Gaussian-based asymptotic approximation (see McGill,
R., Tukey, J.W., and Larsen, W.A., 1978, and Kendall and
Stuart, 1967). Otherwise, bootstrap specifies the number of
times to bootstrap the median to determine its 95%
confidence intervals. Values between 1000 and 10000 are
around the median for notched boxplots. If ``bootstrap`` is
None, no bootstrapping is performed, and notches are
calculated using a Gaussian-based asymptotic approximation
(see McGill, R., Tukey, J.W., and Larsen, W.A., 1978, and
Kendall and Stuart, 1967). Otherwise, bootstrap specifies
the number of times to bootstrap the median to determine its
95% confidence intervals. Values between 1000 and 10000 are
recommended.

usermedians : array-like, optional
Expand Down