Sharey keyword for boxplot #20968

sorenwacker · 2018-05-06T17:03:31Z

…to _subplots().

.. code-block:: jupyter-notebook

%pylab inline
import pandas as pd

N = 100
rand = random.random(N)
clas = random.binomial(5,.5, N)
df = pd.DataFrame({'Rand': rand-clas,
                'Rand2': rand,
                'Class': clas},
                index= np.arange(N))

df.groupby('Class').boxplot(sharey=True, sharex=False)
>>> TypeError: boxplot() got an unexpected keyword argument 'sharey'

New Behavior:

.. ipython:: jpyter-notebook:

...

df.groupby('Class').boxplot(sharey=True, sharex=True)
df.groupby('Class').boxplot(sharey=True, sharex=False)
df.groupby('Class').boxplot(sharey=False, sharex=True)
df.groupby('Class').boxplot(sharey=False, sharex=False)

All leads to different behaviour. The shareing of axes both x and y
can be turned on and off separately.

To restore previous behavior, use boxplot() without keywords.

Default is the previous behavior of sharey

[x ] closes Please, add sharey keyword to boxplot. #20918
[x ] tests added / passed
[ x] passes git diff upstream/master -u -- "*.py" | flake8 --diff
[x ] whatsnew entry

…to _subplots()

codecov · 2018-05-06T18:20:18Z

Codecov Report

Merging #20968 into master will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #20968      +/-   ##
==========================================
+ Coverage   91.85%   91.88%   +0.03%     
==========================================
  Files         153      153              
  Lines       49570    49564       -6     
==========================================
+ Hits        45533    45543      +10     
+ Misses       4037     4021      -16

Flag	Coverage Δ
#multiple	`90.28% <ø> (+0.03%)`	⬆️
#single	`41.86% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/plotting/_core.py	`83.53% <ø> (+1.14%)`	⬆️
pandas/core/reshape/pivot.py	`96.97% <0%> (-0.06%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update abfac97...fd76955. Read the comment docs.

TomAugspurger · 2018-05-07T23:50:59Z

We'll want tests for this. See the e.g. test_sharex_and_ax in pandas/tests/plotting/test_frame.py for an example.

sorenwacker · 2018-05-09T15:07:00Z

Thanks. I will look into that and give it a try.

…words

pep8speaks · 2018-05-09T16:56:41Z

Hello @soerendip! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on June 08, 2018 at 11:26 Hours UTC

TomAugspurger · 2018-05-10T11:19:45Z

doc/source/whatsnew/v0.23.0.txt

@@ -898,6 +898,48 @@ yourself. To revert to the old setting, you can run this line:

  pd.options.display.max_columns = 20

+.. _whatsnew_0230.boxplot.sharexy:
+
+Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot()


This isn't an API change, so we don't need this long of a release note. Probably a single line saying that boxplot now accepts the sharey keyword, and a link to a more detailed example in the docstring or plotting.rst

I updated the docstring and the the part in v0.23.0.txt.

Can you move this to 0.23.1.txt now?

And I think the example can be trimmed down. I'd rather update the docstring for DataFrame.plot.box since that's a longer-term thing. The release note are for people checking changes. They'll see that it now supports sharey, and click through if interested.

TomAugspurger · 2018-05-17T13:02:59Z

doc/source/whatsnew/v0.23.0.txt

@@ -898,6 +898,48 @@ yourself. To revert to the old setting, you can run this line:

  pd.options.display.max_columns = 20

+.. _whatsnew_0230.boxplot.sharexy:
+
+Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot()


Can you move this to 0.23.1.txt now?

TomAugspurger · 2018-05-17T13:05:23Z

doc/source/whatsnew/v0.23.0.txt

@@ -898,6 +898,48 @@ yourself. To revert to the old setting, you can run this line:

  pd.options.display.max_columns = 20

+.. _whatsnew_0230.boxplot.sharexy:
+
+Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot()


And I think the example can be trimmed down. I'd rather update the docstring for DataFrame.plot.box since that's a longer-term thing. The release note are for people checking changes. They'll see that it now supports sharey, and click through if interested.

TomAugspurger · 2018-05-17T13:06:11Z

doc/source/whatsnew/v0.23.0.txt

+
+Previous Behavior:
+
+.. code-block:: jupyter-notebook


See the other examples in /pandas/plotting/_core.py for how these should be formatted.

TomAugspurger · 2018-05-17T13:06:24Z

doc/source/whatsnew/v0.23.0.txt

+
+    ...
+
+    df.groupby('Class').boxplot(sharey=True, sharex=True)


Won't need all of these. Probably just one will convey the point.

Ok, 0.23.1.txt does not exist yet. When I fetch from upstream I don't receive it. Does that mean I should create that file? I thought I already removed the example. Not sure why it still there.

@soerendip did you merge after fetching? The file is there already on master

…arey_keyword_for_boxplot

sorenwacker · 2018-05-18T00:14:59Z

Done. Hope it is correct this time.

TomAugspurger · 2018-05-18T01:57:37Z

pandas/plotting/_core.py

@@ -2567,6 +2567,12 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
    figsize : A tuple (width, height) in inches
    layout : tuple (optional)
        (rows, columns) for the layout of the plot
+    sharex :


Could you take a look at http://pandas.pydata.org/pandas-docs/stable/contributing_docstring.html for how to format these? Something like

sharex : bool, default False Whether the horizontal axes is shared among subplots

Ok, did that. Should this part of the doc-string then be corrected as well?

subplots : * ``False`` - no subplots will be used * ``True`` - create a subplot for each group

TomAugspurger · 2018-05-18T02:03:15Z

pandas/tests/plotting/test_frame.py

+
+        # standart behavior
+        axes = df.groupby('c').boxplot()
+        self._check_visible(axes[0].get_yticklabels(), visible=True)


These tests are a bit wordy. I wonder if the following is clear?

expected = pd.Series([True, False, True, False]) result = axes.apply(lambda ax: ax.yaxis.get_visible()) tm.assert_frame_equal(result, expected)

Is that the same? Do you find it clearer?

I see where you want to go. Would this be acceptable? It uses a function that you might want somewhere else though in case you want to use it in other tests? Where would be a good position to put it?

def test_groupby_boxplot_sharex(self): def _assert_xtickslabels_visibility(axes, expected): for ax, exp in zip(axes, expected): self._check_visible(ax.get_xticklabels(), visible=exp) df = DataFrame({'a': [-1.43, -0.15, -3.70, -1.43, -0.14], 'b': [0.56, 0.84, 0.29, 0.56, 0.85], 'c': [0, 1, 2, 3, 1]}, index=[0, 1, 2, 3, 4]) # standart behavior axes = df.groupby('c').boxplot() expected = [True, True, True, True] _assert_xtickslabels_visibility(axes, expected) # set sharex=False should be identical axes = df.groupby('c').boxplot(sharex=False) expected = [True, True, True, True] _assert_xtickslabels_visibility(axes, expected) # sharex=True, xticklabels should be visible only for bottom plots axes = df.groupby('c').boxplot(sharex=True) expected = [False, False, True, True] _assert_xtickslabels_visibility(axes, expected)´

sorenwacker · 2018-05-28T16:36:56Z

Any updates on this? I shortened the tests in the style of your examples using the assert function that was implemented to check for visibility. However, I had to create two helper functions, and was not sure where the optimal place for those is.

jreback · 2018-05-29T00:38:15Z

pandas/plotting/_core.py

@@ -2567,6 +2567,10 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
    figsize : A tuple (width, height) in inches
    layout : tuple (optional)
        (rows, columns) for the layout of the plot
+    sharex : bool, default False
+        Whether x-axes will be shared among subplots


add a versionadded tag (0.23.1)

Like this? I added this to v.0.23.1.txt.

Plotting ^^^^^^^^ - Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot() (:issue: `20968`)

If not, could you be more specific about what I should add where, please?

sharey : bool, default False Whether y-axes will be shared among subplots .. versionadded:: 0.23.1

jreback · 2018-05-29T00:38:52Z

pandas/tests/plotting/test_frame.py

+        # sharey can now be switched check whether the right
+        # pair of axes is turned on or off
+
+        def _assert_ytickslabels_visibility(axes, expected):


do we have similar functions at a top level? maybe we should

Sorry, I am new to pandas. I am not sure whether I understand what you mean. Are you saying, I should move the function somewhere else? If yes, where exactly should the function go?

you can make this a function on the class itself rather than defininig it inside the function

jreback · 2018-05-29T00:39:04Z

pandas/tests/plotting/test_frame.py

+        # standart behavior
+        axes = df.groupby('c').boxplot()
+        expected = [True, False, True, False]
+        _assert_ytickslabels_visibility(axes, expected)


use a blank line between cases

sorenwacker · 2018-06-01T00:43:19Z

All changes should be done.

jreback · 2018-06-04T21:48:33Z

doc/source/whatsnew/v0.23.0.txt

+
+Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot()
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+(:issue:`15184`)


this file needs to be reverted

jreback · 2018-06-04T21:49:42Z

pandas/tests/plotting/test_frame.py

+        # sharey can now be switched check whether the right
+        # pair of axes is turned on or off
+
+        def _assert_ytickslabels_visibility(axes, expected):


you can make this a function on the class itself rather than defininig it inside the function

jreback · 2018-06-04T21:49:51Z

pandas/tests/plotting/test_frame.py

+                        'c': [0, 1, 2, 3, 1]},
+                       index=[0, 1, 2, 3, 4])
+
+        # standart behavior


what is 'standard' mean here, can you update the comment

…or tests without keywords

TomAugspurger · 2018-06-06T21:30:44Z

@soerendip looks like tests are failing in the latest commit.

sorenwacker · 2018-06-06T21:39:21Z

That’s when you think “it’s so easy it can’t fail”... will look into this.

…

________________________________ From: Tom Augspurger <[email protected]> Sent: Wednesday, June 6, 2018 2:31:23 PM To: pandas-dev/pandas Cc: Sören; Mention Subject: Re: [pandas-dev/pandas] Sharey keyword for boxplot (#20968) @soerendip<https://github.com/soerendip> looks like tests are failing in the latest commit. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#20968 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ADPAfiKwkip_0MRFE3KD0qoRShVy2QZ0ks5t6EorgaJpZM4T0HJx>.

jreback · 2018-06-07T11:06:27Z

doc/source/whatsnew/v0.23.1.txt

@@ -76,7 +76,7 @@ I/O
 Plotting
 ^^^^^^^^

-
+- Optional sharing of x/y-axis by pandas.DataFrame().groupby().boxplot() (:issue: `20968`)


its not clear to me what is being fixed / enhancement here, can you re-word

jreback · 2018-06-07T11:07:42Z

pandas/tests/plotting/test_frame.py

@@ -2921,6 +2972,14 @@ def test_secondary_axis_font_size(self, method):
        self._check_ticks_props(axes=ax.right_ax,
                                ylabelsize=fontsize)

+    def _assert_ytickslabels_visibility(self, axes, expected):


you you move these to the very top of the class (I think we hvae other checker functions there)

sorenwacker · 2018-06-07T18:10:03Z

Done.

jreback · 2018-06-08T11:27:34Z

thanks @soerendip

sorenwacker added 2 commits May 5, 2018 16:52

Added keywords (sharex, sharey) to boxplot_frame_groupby and pass it …

cb80356

…to _subplots()

Added documentation for new feature.

8d822b0

gfyoung added Visualization plotting Enhancement labels May 8, 2018

Added tests for DataFrame.groupby().boxplot()'s sharex and sharey key…

eb71a8e

…words

Flake8 fixed

dc7f3f5

TomAugspurger reviewed May 10, 2018

View reviewed changes

TomAugspurger reviewed May 17, 2018

View reviewed changes

sorenwacker added 3 commits May 17, 2018 17:39

Removed the example from 0.23.0.txt and generated v0.23.1.txt

9cb994c

Merge branch 'master' of https://github.com/pandas-dev/pandas into sh…

849105a

…arey_keyword_for_boxplot

Added comment to Plotting

64aac34

TomAugspurger reviewed May 18, 2018

View reviewed changes

sorenwacker added 3 commits May 18, 2018 11:35

Added comment regarding new sharex, sharey feature of boxplot()

8dc0e9b

Made tests for sharex, sharey keywords of boxplot shorter.

6bff510

Formated docstring

cfc0a5f

jreback requested changes May 29, 2018

View reviewed changes

jreback added this to the 0.23.1 milestone May 29, 2018

sorenwacker added 2 commits May 28, 2018 22:19

Added blank lines between cases

6c0c324

added versionadded tag

e0a5515

jreback requested changes Jun 4, 2018

View reviewed changes

sorenwacker added 2 commits June 6, 2018 12:52

reverted v0.23.0.txt

6b4d371

Moved helper functions out of test cases; clarification of comments f…

c1d5cab

…or tests without keywords

Moved helper functions out of test cases, and fixed them

26ef598

jreback requested changes Jun 7, 2018

View reviewed changes

Moved helper functions to the top; clarified doc string

42d7286

jreback added 2 commits June 8, 2018 07:24

Merge branch 'master' into PR_TOOL_MERGE_PR_20968

7a65d8a

add sub-section highlites

fd76955

jreback approved these changes Jun 8, 2018

View reviewed changes

jreback merged commit 4f1704e into pandas-dev:master Jun 8, 2018

daminisatya pushed a commit to daminisatya/pandas that referenced this pull request Jun 8, 2018

Sharey keyword for boxplot (pandas-dev#20968)

7471f3e

jorisvandenbossche modified the milestones: 0.23.1, 0.24.0 Jun 8, 2018

david-liu-brattle-1 pushed a commit to david-liu-brattle-1/pandas that referenced this pull request Jun 18, 2018

Sharey keyword for boxplot (pandas-dev#20968)

357850a

Sharey keyword for boxplot #20968

Sharey keyword for boxplot #20968

Conversation

sorenwacker commented May 6, 2018

codecov bot commented May 6, 2018 • edited Loading

Codecov Report

TomAugspurger commented May 7, 2018

sorenwacker commented May 9, 2018

pep8speaks commented May 9, 2018 • edited Loading

Comment last updated on June 08, 2018 at 11:26 Hours UTC

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sorenwacker commented May 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sorenwacker commented May 28, 2018 • edited Loading

jreback May 29, 2018 • edited Loading

Choose a reason for hiding this comment

sorenwacker May 29, 2018 • edited Loading

Choose a reason for hiding this comment

TomAugspurger May 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sorenwacker commented Jun 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Jun 6, 2018

sorenwacker commented Jun 6, 2018 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sorenwacker commented Jun 7, 2018

jreback commented Jun 8, 2018

codecov bot commented May 6, 2018 •

edited

Loading

pep8speaks commented May 9, 2018 •

edited

Loading

sorenwacker commented May 28, 2018 •

edited

Loading

jreback May 29, 2018 •

edited

Loading

sorenwacker May 29, 2018 •

edited

Loading

TomAugspurger May 29, 2018 •

edited

Loading