Skip to content

Commit 3b99630

Browse files
committed
DOC: specified the keys of the dictionaries returned by cbook.boxplot_stats
1 parent a79448e commit 3b99630

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

lib/matplotlib/cbook.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1883,7 +1883,18 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None):
18831883
Returns
18841884
-------
18851885
bxpstats : A list of dictionaries containing the results for each column
1886-
of data. Keys are as
1886+
of data. Keys of each dictionary are the following:
1887+
- label = tick label for the boxplot
1888+
- mean = mean value (can plot as a line or point)
1889+
- median = 50th percentile
1890+
- q1 = first quartile (25th pctl)
1891+
- q3 = third quartile (75 (pctl)
1892+
- cilo = lower notch around the median
1893+
- ciho = upper notch around the median
1894+
- whislo = end of the lower whisker
1895+
- whishi = end of the upper whisker
1896+
- fliers = outliers
1897+
18871898
18881899
Notes
18891900
-----

0 commit comments

Comments
 (0)