Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Update MEP 28 #8391

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
Apr 2, 2017
Merged

DOC: Update MEP 28 #8391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
568e294
DOC: fix minor typos and formatting (MEP28)
phobson Mar 27, 2017
93fd84a
DOC: include 2D array deprecation, accelerate schedule
phobson Mar 27, 2017
d5d9a0f
DOC: add relevant branches to MEP28
phobson Mar 28, 2017
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
52 changes: 28 additions & 24 deletions doc/devel/MEP/MEP28.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,28 @@
=============================================
MEP 28: Remove Complexity from Axes.boxplot
MEP28: Remove Complexity from Axes.boxplot
=============================================

.. contents::
:local:


Status
======

..
.. MEPs go through a number of phases in their lifetime:

**Discussion**
..
.. - **Progress**: Consensus was reached on the mailing list and
.. implementation work has begun.
..
.. - **Completed**: The implementation has been merged into master.
..
.. - **Superseded**: This MEP has been abandoned in favor of another
.. approach.

Branches and Pull requests
==========================

Adding pre- & post-processing options to ``cbook.boxplot_stats``: https://github.com/phobson/matplotlib/tree/boxplot-stat-transforms
Exposing ``cbook.boxplot_stats`` through ``Axes.boxplot`` kwargs: None
Remove redundant statistical kwargs in ``Axes.boxplot``: None
Remove redundant style options in ``Axes.boxplot``: None
Remaining items that arise through discussion: None
The following lists any open PRs or branches related to this MEP:

#. Deprecate redundant statistical kwargs in ``Axes.boxplot``: https://github.com/phobson/matplotlib/tree/MEP28-initial-deprecations
#. Deprecate redundant style options in ``Axes.boxplot``: https://github.com/phobson/matplotlib/tree/MEP28-initial-deprecations
#. Deprecate passings 2D numpy arrays as input: None
#. Add pre- & post-processing options to ``cbook.boxplot_stats``: https://github.com/phobson/matplotlib/tree/boxplot-stat-transforms
#. Exposing ``cbook.boxplot_stats`` through ``Axes.boxplot`` kwargs: None
#. Remove redundant statistical kwargs in ``Axes.boxplot``: None
#. Remove redundant style options in ``Axes.boxplot``: None
#. Remaining items that arise through discussion: None

Abstract
========
Expand Down Expand Up @@ -121,7 +115,7 @@ data differently depending one these types of transforms.
ax.set_yscale('log')
data = np.random.lognormal(-1.75, 2.75, size=37)

stats = cbook.boxplot_stats(data, labels=['arimetic'])
stats = cbook.boxplot_stats(data, labels=['arithmetic'])
logstats = cbook.boxplot_stats(np.log(data), labels=['log-transformed'])

for lsdict in logstats:
Expand Down Expand Up @@ -203,11 +197,21 @@ Schedule
An accelerated timeline could look like the following:

#. v2.0.1 add transforms to ``cbook.boxplots_stats``, expose in ``Axes.boxplot``
#. v2.1.0 deprecate ``usermedians``, ``conf_intervals``, ``sym`` parameters
#. v2.2.0 make deprecations noisier
#. v2.3.0 remove ``usermedians``, ``conf_intervals``, ``sym`` parameters
#. v2.3.0 deprecate ``notch`` in favor of ``shownotches`` to be consistent with other parameters and ``Axes.bxp``
#. v2.4.0 remove ``notch`` parameter, move all style and artist toggling logic to ``Axes.bxp``. ``Axes.boxplot`` is little more than a broker between ``Axes.bxp`` and ``cbook.boxplots_stats``
#. v2.1.0 Initial Deprecations , and using 2D numpy arrays as input

a. Using 2D numpy arrays as input. The semantics around 2D arrays are generally confusing.
b. ``usermedians``, ``conf_intervals``, ``sym`` parameters

#. v2.2.0

a. remove ``usermedians``, ``conf_intervals``, ``sym`` parameters
b. deprecate ``notch`` in favor of ``shownotches`` to be consistent with
other parameters and ``Axes.bxp``

#. v2.3.0
a. remove ``notch`` parameter
b. move all style and artist toggling logic to ``Axes.bxp`` such ``Axes.boxplot``
is little more than a broker between ``Axes.bxp`` and ``cbook.boxplots_stats``


Anticipated Impacts to Users
Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3280,6 +3280,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
whis = rcParams['boxplot.whiskers']
if bootstrap is None:
bootstrap = rcParams['boxplot.bootstrap']

bxpstats = cbook.boxplot_stats(x, whis=whis, bootstrap=bootstrap,
labels=labels, autorange=autorange)
if notch is None:
Expand Down