Skip to content

BUG: Fix error for boxplot when using a pre-grouped DataFrame with more than one grouping #57985

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 9 commits into from
Mar 31, 2024
Merged

BUG: Fix error for boxplot when using a pre-grouped DataFrame with more than one grouping #57985

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
81607c3
Fix BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 24, 2024
6a346dd
Add test for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 24, 2024
3c741ea
Add docs for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 24, 2024
e9811fc
Merge remote-tracking branch 'upstream/main' into 14701_boxplot_groupby
thetestspecimen Mar 31, 2024
6f084e1
Update tests for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 31, 2024
a326529
Update docs for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 31, 2024
50c0e38
Update logic for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 31, 2024
dacaf2d
Extract Series creation from for loop
thetestspecimen Mar 31, 2024
e3124c0
Update docs for BUG-14701 allow multiple groupby groups for boxplot
thetestspecimen Mar 31, 2024
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
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v3.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ Period

Plotting
^^^^^^^^
-
- Bug in :meth:`DataFrameGroupBy.boxplot` passes a ``tuple`` instead of a ``string`` when input ``DataFrame`` is pre-grouped using more than one ``column`` (:issue:`14701`)
Copy link
Member

Choose a reason for hiding this comment

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

The link to the API docs won't resolve unless you include a . before DataFrameGroupBy; so it should be :meth:`.DataFrameGroupBy.boxplot`

-

Groupby/resample/rolling
Expand Down
4 changes: 3 additions & 1 deletion pandas/plotting/_matplotlib/boxplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,9 @@ def boxplot_frame_groupby(
ax=ax, column=column, fontsize=fontsize, rot=rot, grid=grid, **kwds
)
ax.set_title(pprint_thing(key))
ret.loc[key] = d
# GH 14701 'key' needs to be converted to text as 'key' is a tuple when
# there is more than one group
ret.loc[pprint_thing(key)] = d
Copy link
Member

Choose a reason for hiding this comment

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

Instead of ret = pd.Series(dtype=object) above, can you do:

data = {}
for (key, group), ax in zip(grouped, axes):
    ...
    data[key] = d
ret = pd.Series(data)

In general one should not construct a Series row-by-row (this is very slow), but rather provide all the data upfront. I think this will also allow tuples for key.

maybe_adjust_figure(fig, bottom=0.15, top=0.9, left=0.1, right=0.9, wspace=0.2)
else:
keys, frames = zip(*grouped)
Expand Down
14 changes: 14 additions & 0 deletions pandas/tests/plotting/test_boxplot_method.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,3 +740,17 @@ def test_boxplot_multiindex_column(self):
expected_xticklabel = ["(bar, one)", "(bar, two)"]
result_xticklabel = [x.get_text() for x in axes.get_xticklabels()]
assert expected_xticklabel == result_xticklabel

@pytest.mark.parametrize("group", ["X", ["X", "Y"]])
def test_boxplot_multi_groupby_groups(self, group):
# GH 14701
rows = 20
df = DataFrame(
np.random.default_rng(12).normal(size=(rows, 2)), columns=["Col1", "Col2"]
)
df["X"] = Series(np.repeat(["A", "B"], int(rows / 2)))
df["Y"] = Series(np.tile(["C", "D"], int(rows / 2)))
pregrouped = df.groupby(group)
Copy link
Member

Choose a reason for hiding this comment

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

nit: Just to adhere to existing conventions in tests, could you either call this grouped or gb. These are the names used in other tests here.

_check_plot_works(df.boxplot, by=group, default_axes=True)
_check_plot_works(df.plot.box, by=group, default_axes=True)
_check_plot_works(pregrouped.boxplot, default_axes=True)