|
1 | 1 | =============================================
|
2 |
| - MEP 28: Remove Complexity from Axes.boxplot |
| 2 | + MEP28: Remove Complexity from Axes.boxplot |
3 | 3 | =============================================
|
4 | 4 |
|
5 | 5 | .. contents::
|
6 | 6 | :local:
|
7 | 7 |
|
| 8 | + |
8 | 9 | Status
|
9 | 10 | ======
|
10 |
| - |
11 |
| -.. |
12 |
| -.. MEPs go through a number of phases in their lifetime: |
13 |
| -
|
14 | 11 | **Discussion**
|
15 |
| -.. |
16 |
| -.. - **Progress**: Consensus was reached on the mailing list and |
17 |
| -.. implementation work has begun. |
18 |
| -.. |
19 |
| -.. - **Completed**: The implementation has been merged into master. |
20 |
| -.. |
21 |
| -.. - **Superseded**: This MEP has been abandoned in favor of another |
22 |
| -.. approach. |
23 | 12 |
|
24 | 13 | Branches and Pull requests
|
25 | 14 | ==========================
|
26 | 15 |
|
27 |
| -Adding pre- & post-processing options to ``cbook.boxplot_stats``: https://github.com/phobson/matplotlib/tree/boxplot-stat-transforms |
28 |
| -Exposing ``cbook.boxplot_stats`` through ``Axes.boxplot`` kwargs: None |
29 |
| -Remove redundant statistical kwargs in ``Axes.boxplot``: None |
30 |
| -Remove redundant style options in ``Axes.boxplot``: None |
31 |
| -Remaining items that arise through discussion: None |
| 16 | +The following lists any open PRs or branches related to this MEP: |
| 17 | + |
| 18 | +#. Deprecate redundant statistical kwargs in ``Axes.boxplot``: https://github.com/phobson/matplotlib/tree/MEP28-initial-deprecations |
| 19 | +#. Deprecate redundant style options in ``Axes.boxplot``: https://github.com/phobson/matplotlib/tree/MEP28-initial-deprecations |
| 20 | +#. Deprecate passings 2D numpy arrays as input: None |
| 21 | +#. Add pre- & post-processing options to ``cbook.boxplot_stats``: https://github.com/phobson/matplotlib/tree/boxplot-stat-transforms |
| 22 | +#. Exposing ``cbook.boxplot_stats`` through ``Axes.boxplot`` kwargs: None |
| 23 | +#. Remove redundant statistical kwargs in ``Axes.boxplot``: None |
| 24 | +#. Remove redundant style options in ``Axes.boxplot``: None |
| 25 | +#. Remaining items that arise through discussion: None |
32 | 26 |
|
33 | 27 | Abstract
|
34 | 28 | ========
|
@@ -121,7 +115,7 @@ data differently depending one these types of transforms.
|
121 | 115 | ax.set_yscale('log')
|
122 | 116 | data = np.random.lognormal(-1.75, 2.75, size=37)
|
123 | 117 |
|
124 |
| - stats = cbook.boxplot_stats(data, labels=['arimetic']) |
| 118 | + stats = cbook.boxplot_stats(data, labels=['arithmetic']) |
125 | 119 | logstats = cbook.boxplot_stats(np.log(data), labels=['log-transformed'])
|
126 | 120 |
|
127 | 121 | for lsdict in logstats:
|
@@ -203,11 +197,21 @@ Schedule
|
203 | 197 | An accelerated timeline could look like the following:
|
204 | 198 |
|
205 | 199 | #. v2.0.1 add transforms to ``cbook.boxplots_stats``, expose in ``Axes.boxplot``
|
206 |
| -#. v2.1.0 deprecate ``usermedians``, ``conf_intervals``, ``sym`` parameters |
207 |
| -#. v2.2.0 make deprecations noisier |
208 |
| -#. v2.3.0 remove ``usermedians``, ``conf_intervals``, ``sym`` parameters |
209 |
| -#. v2.3.0 deprecate ``notch`` in favor of ``shownotches`` to be consistent with other parameters and ``Axes.bxp`` |
210 |
| -#. 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`` |
| 200 | +#. v2.1.0 Initial Deprecations , and using 2D numpy arrays as input |
| 201 | + |
| 202 | + a. Using 2D numpy arrays as input. The semantics around 2D arrays are generally confusing. |
| 203 | + b. ``usermedians``, ``conf_intervals``, ``sym`` parameters |
| 204 | + |
| 205 | +#. v2.2.0 |
| 206 | + |
| 207 | + a. remove ``usermedians``, ``conf_intervals``, ``sym`` parameters |
| 208 | + b. deprecate ``notch`` in favor of ``shownotches`` to be consistent with |
| 209 | + other parameters and ``Axes.bxp`` |
| 210 | + |
| 211 | +#. v2.3.0 |
| 212 | + a. remove ``notch`` parameter |
| 213 | + b. move all style and artist toggling logic to ``Axes.bxp`` such ``Axes.boxplot`` |
| 214 | + is little more than a broker between ``Axes.bxp`` and ``cbook.boxplots_stats`` |
211 | 215 |
|
212 | 216 |
|
213 | 217 | Anticipated Impacts to Users
|
|
0 commit comments