DOC: Minor improvements groupby user guide #56465
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rhshadrach
commented
Dec 12, 2023
| @@ -602,7 +601,7 @@ Any reduction method that pandas implements can be passed as a string to | |||
| grouped.agg("sum") | |||
|
|
|||
| The result of the aggregation will have the group names as the | |||
| new index along the grouped axis. In the case of multiple keys, the result is a | |||
| new index. In the case of multiple keys, the result is a | |||
There was a problem hiding this comment.
Removed since axis=1 is deprecated
rhshadrach
commented
Dec 12, 2023
| @@ -846,15 +845,14 @@ The following methods on GroupBy act as transformations. Of these methods, only | |||
| :meth:`~.DataFrameGroupBy.cumsum`;Compute the cumulative sum within each group | |||
| :meth:`~.DataFrameGroupBy.diff`;Compute the difference between adjacent values within each group | |||
| :meth:`~.DataFrameGroupBy.ffill`;Forward fill NA values within each group | |||
| :meth:`~.DataFrameGroupBy.fillna`;Fill NA values within each group | |||
There was a problem hiding this comment.
Removed since fillna is deprecated
rhshadrach
commented
Dec 12, 2023
|
|
||
| # Use .agg function to aggregate over standard and "nuisance" data types | ||
| # at the same time | ||
| df_dec.groupby(["id"]).agg({"int_column": "sum", "dec_column": "sum"}) |
There was a problem hiding this comment.
You used to need to do this to include nuisance columns; not anymore. Now they are included by default.
rhshadrach
commented
Dec 12, 2023
| @@ -1350,35 +1339,53 @@ The returned dtype of the grouped will *always* include *all* of the categories | |||
|
|
|||
| s = ( | |||
| pd.Series([1, 1, 1]) | |||
| .groupby(pd.Categorical(["a", "a", "a"], categories=["a", "b"]), observed=False) | |||
| .groupby(pd.Categorical(["a", "a", "a"], categories=["a", "b"]), observed=True) | |||
There was a problem hiding this comment.
This demonstrates unobserved categories are being kept, so I think it makes more sense to show with observed=True
|
Just noting to feel free to liberally move examples and behavior notes to docstrings or remove sections that are too niche/outdated. IMO I feel that information is best served in docstrings as opposed to user guides given how outdated they are |
mroeschke
approved these changes
Dec 12, 2023
|
Thanks @rhshadrach |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.