Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 05d910d

Browse filesBrowse files
committed
Merge pull request #6703 from phobson/bxp-notch-docs
DOC: explain behavior of notches beyond quartiles
1 parent 7f4191b commit 05d910d
Copy full SHA for 05d910d

File tree

Expand file treeCollapse file tree

1 file changed

+20
-8
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+20
-8
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+20-8Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3097,7 +3097,19 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
30973097
30983098
notch : bool, optional (False)
30993099
If `True`, will produce a notched box plot. Otherwise, a
3100-
rectangular boxplot is produced.
3100+
rectangular boxplot is produced. The notches represent the
3101+
confidence interval (CI) around the median. See the entry
3102+
for the ``bootstrap`` parameter for information regarding
3103+
how the locations of the notches are computed.
3104+
3105+
.. note::
3106+
3107+
In cases where the values of the CI are less than the
3108+
lower quartile or greater than the upper quartile, the
3109+
notches will extend beyond the box, giving it a
3110+
distinctive "flipped" appearance. This is expected
3111+
behavior and consistent with other statistical
3112+
visualization packages.
31013113
31023114
sym : str, optional
31033115
The default symbol for flier points. Enter an empty string
@@ -3123,13 +3135,13 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
31233135
31243136
bootstrap : int, optional
31253137
Specifies whether to bootstrap the confidence intervals
3126-
around the median for notched boxplots. If `bootstrap` is None,
3127-
no bootstrapping is performed, and notches are calculated
3128-
using a Gaussian-based asymptotic approximation (see McGill,
3129-
R., Tukey, J.W., and Larsen, W.A., 1978, and Kendall and
3130-
Stuart, 1967). Otherwise, bootstrap specifies the number of
3131-
times to bootstrap the median to determine its 95%
3132-
confidence intervals. Values between 1000 and 10000 are
3138+
around the median for notched boxplots. If ``bootstrap`` is
3139+
None, no bootstrapping is performed, and notches are
3140+
calculated using a Gaussian-based asymptotic approximation
3141+
(see McGill, R., Tukey, J.W., and Larsen, W.A., 1978, and
3142+
Kendall and Stuart, 1967). Otherwise, bootstrap specifies
3143+
the number of times to bootstrap the median to determine its
3144+
95% confidence intervals. Values between 1000 and 10000 are
31333145
recommended.
31343146
31353147
usermedians : array-like, optional

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.