Skip to content

DOC: clarified docstring for cbook.boxplot_stats #2819

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 3 commits into from
Feb 25, 2014
Merged

DOC: clarified docstring for cbook.boxplot_stats #2819

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b99630
DOC: specified the keys of the dictionaries returned by cbook.boxplot…
phobson Feb 17, 2014
5ba30aa
DOC: formatted key-value list as a table and added some latex math
phobson Feb 17, 2014
bdba773
DOC: fixed newlines around table and end of docstring
phobson Feb 24, 2014
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
22 changes: 20 additions & 2 deletions lib/matplotlib/cbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1883,16 +1883,34 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None):
Returns
-------
bxpstats : A list of dictionaries containing the results for each column
of data. Keys are as
of data. Keys of each dictionary are the following:

======== ===================================
Key Value Description
======== ===================================
label tick label for the boxplot
mean arithemetic mean value
median 50th percentile
q1 first quartile (25th percentile)
q3 third quartile (75th percentile)
cilo lower notch around the median
ciho upper notch around the median
whislo end of the lower whisker
whishi end of the upper whisker
fliers outliers
======== ===================================

Notes
-----
Non-bootstrapping approach to confidence interval uses Gaussian-based
asymptotic approximation.
asymptotic approximation:

.. math:: \mathrm{med} \pm 1.57 \times \frac{\mathrm{iqr}}{\sqrt{N}}

General approach from:
McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of
Boxplots", The American Statistician, 32:12-16.

'''

def _bootstrap_median(data, N=5000):
Expand Down