Skip to content

DOC: Adding examples to DataFrameGroupBy.rank #38972 #42402

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
Jul 12, 2021
Merged

DOC: Adding examples to DataFrameGroupBy.rank #38972 #42402

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
adbdcb1
DOC: Adding examples to DataFrameGroupBy.rank #38972
debnathshoham Jul 6, 2021
ff71390
DOC: Adding examples to DataFrameGroupBy.rank #38972
debnathshoham Jul 6, 2021
ab42746
DOC: made the suggested changes
debnathshoham Jul 6, 2021
76e4df1
Merge branch 'master' of https://github.com/debnathshoham/pandas into…
debnathshoham Jul 11, 2021
1b2dde5
DOC: changed as suggested
debnathshoham Jul 11, 2021
81000b7
DOC: changed as suggested
debnathshoham Jul 11, 2021
98b90c6
DOC: updating with black output
debnathshoham Jul 11, 2021
ed08832
DOC: updating with black output
debnathshoham Jul 11, 2021
0032ae4
DOC: corrected docstring order
debnathshoham Jul 11, 2021
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
37 changes: 36 additions & 1 deletion pandas/core/groupby/groupby.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2637,7 +2637,7 @@ def cumcount(self, ascending: bool = True):

@final
@Substitution(name="groupby")
@Appender(_common_see_also)
@Substitution(see_also=_common_see_also)
def rank(
self,
method: str = "average",
Expand Down Expand Up @@ -2671,6 +2671,41 @@ def rank(
Returns
-------
DataFrame with ranking of values within each group
%(see_also)s
Examples
--------
>>> df = pd.DataFrame(
... {
... "group": ["a", "a", "a", "a", "a", "b", "b", "b", "b", "b"],
... "value": [2, 4, 2, 3, 5, 1, 2, 4, 1, 5],
... }
... )
>>> df
group value
0 a 2
1 a 4
2 a 2
3 a 3
4 a 5
5 b 1
6 b 2
7 b 4
8 b 1
9 b 5
>>> for method in ['average', 'min', 'max', 'dense', 'first']:
... df[f'{method}_rank'] = df.groupby('group')['value'].rank(method)
>>> df
group value average_rank min_rank max_rank dense_rank first_rank
0 a 2 1.5 1.0 2.0 1.0 1.0
1 a 4 4.0 4.0 4.0 3.0 4.0
2 a 2 1.5 1.0 2.0 1.0 2.0
3 a 3 3.0 3.0 3.0 2.0 3.0
4 a 5 5.0 5.0 5.0 4.0 5.0
5 b 1 1.5 1.0 2.0 1.0 1.0
6 b 2 3.0 3.0 3.0 2.0 3.0
7 b 4 4.0 4.0 4.0 3.0 4.0
8 b 1 1.5 1.0 2.0 1.0 2.0
9 b 5 5.0 5.0 5.0 4.0 5.0
"""
if na_option not in {"keep", "top", "bottom"}:
msg = "na_option must be one of 'keep', 'top', or 'bottom'"
Expand Down