Skip to content

Sharey keyword for boxplot #20968

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 18 commits into from
Jun 8, 2018
Merged

Sharey keyword for boxplot #20968

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
cb80356
Added keywords (sharex, sharey) to boxplot_frame_groupby and pass it …
sorenwacker May 5, 2018
8d822b0
Added documentation for new feature.
sorenwacker May 6, 2018
eb71a8e
Added tests for DataFrame.groupby().boxplot()'s sharex and sharey key…
sorenwacker May 9, 2018
dc7f3f5
Flake8 fixed
sorenwacker May 9, 2018
9cb994c
Removed the example from 0.23.0.txt and generated v0.23.1.txt
sorenwacker May 17, 2018
849105a
Merge branch 'master' of https://github.com/pandas-dev/pandas into sh…
sorenwacker May 18, 2018
64aac34
Added comment to Plotting
sorenwacker May 18, 2018
8dc0e9b
Added comment regarding new sharex, sharey feature of boxplot()
sorenwacker May 18, 2018
6bff510
Made tests for sharex, sharey keywords of boxplot shorter.
sorenwacker May 18, 2018
cfc0a5f
Formated docstring
sorenwacker May 19, 2018
6c0c324
Added blank lines between cases
sorenwacker May 29, 2018
e0a5515
added versionadded tag
sorenwacker May 29, 2018
6b4d371
reverted v0.23.0.txt
sorenwacker Jun 6, 2018
c1d5cab
Moved helper functions out of test cases; clarification of comments f…
sorenwacker Jun 6, 2018
26ef598
Moved helper functions out of test cases, and fixed them
sorenwacker Jun 6, 2018
42d7286
Moved helper functions to the top; clarified doc string
sorenwacker Jun 7, 2018
7a65d8a
Merge branch 'master' into PR_TOOL_MERGE_PR_20968
jreback Jun 8, 2018
fd76955
add sub-section highlites
jreback Jun 8, 2018
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
8 changes: 8 additions & 0 deletions doc/source/whatsnew/v0.23.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,14 @@ 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()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move this to 0.23.1.txt now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
(:issue:`15184`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file needs to be reverted


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

.. _whatsnew_0230.api.datetimelike:

Datetimelike API Changes
Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.23.1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ I/O
Plotting
^^^^^^^^

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

Reshaping
Expand Down
10 changes: 8 additions & 2 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2548,7 +2548,7 @@ def plot_group(group, ax):

def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
rot=0, grid=True, ax=None, figsize=None,
layout=None, **kwds):
layout=None, sharex=False, sharey=True, **kwds):
"""
Make box plots from DataFrameGroupBy data.

Expand All @@ -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 :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

* ``True`` - x-axes will be shared among subplots
* ``False`` - x-axes will not be shared
sharey :
* ``True`` - y-axes will be shared among subplots
* ``False`` - y-axes will not be shared
`**kwds` : Keyword Arguments
All other plotting keyword arguments to be passed to
matplotlib's boxplot function
Expand Down Expand Up @@ -2598,7 +2604,7 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
if subplots is True:
naxes = len(grouped)
fig, axes = _subplots(naxes=naxes, squeeze=False,
ax=ax, sharex=False, sharey=True,
ax=ax, sharex=sharex, sharey=sharey,
figsize=figsize, layout=layout)
axes = _flatten(axes)

Expand Down
58 changes: 58 additions & 0 deletions pandas/tests/plotting/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,64 @@ def test_subplots(self):
for ax in axes:
assert ax.get_legend() is None

def test_groupby_boxplot_sharey(self):
# https://github.com/pandas-dev/pandas/issues/9737 using gridspec,
# the axis in fig.get_axis() are sorted differently than pandas
# expected them, so make sure that only the right ones are removed

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

standard

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

axes = df.groupby('c').boxplot()
self._check_visible(axes[0].get_yticklabels(), visible=True)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)´

self._check_visible(axes[1].get_yticklabels(), visible=False)
self._check_visible(axes[2].get_yticklabels(), visible=True)
self._check_visible(axes[3].get_yticklabels(), visible=False)
# set sharey=True should be identical
axes = df.groupby('c').boxplot(sharey=True)
self._check_visible(axes[0].get_yticklabels(), visible=True)
self._check_visible(axes[1].get_yticklabels(), visible=False)
self._check_visible(axes[2].get_yticklabels(), visible=True)
self._check_visible(axes[3].get_yticklabels(), visible=False)
# sharey=False, all yticklabels should be visible
axes = df.groupby('c').boxplot(sharey=False)
self._check_visible(axes[0].get_yticklabels(), visible=True)
self._check_visible(axes[1].get_yticklabels(), visible=True)
self._check_visible(axes[2].get_yticklabels(), visible=True)
self._check_visible(axes[3].get_yticklabels(), visible=True)

def test_groupby_boxplot_sharex(self):
# https://github.com/pandas-dev/pandas/issues/9737 using gridspec,
# the axis in fig.get_axis() are sorted differently than pandas
# expected them, so make sure that only the right ones are removed

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()
self._check_visible(axes[0].get_xticklabels(), visible=True)
self._check_visible(axes[1].get_xticklabels(), visible=True)
self._check_visible(axes[2].get_xticklabels(), visible=True)
self._check_visible(axes[3].get_xticklabels(), visible=True)
# set sharex=False should be identical
axes = df.groupby('c').boxplot(sharex=False)
self._check_visible(axes[0].get_xticklabels(), visible=True)
self._check_visible(axes[1].get_xticklabels(), visible=True)
self._check_visible(axes[2].get_xticklabels(), visible=True)
self._check_visible(axes[3].get_xticklabels(), visible=True)
# sharex=True, yticklabels should be visible for bottom plots
axes = df.groupby('c').boxplot(sharex=True)
self._check_visible(axes[0].get_xticklabels(), visible=False)
self._check_visible(axes[1].get_xticklabels(), visible=False)
self._check_visible(axes[2].get_xticklabels(), visible=True)
self._check_visible(axes[3].get_xticklabels(), visible=True)

@pytest.mark.slow
def test_subplots_timeseries(self):
idx = date_range(start='2014-07-01', freq='M', periods=10)
Expand Down