Skip to content

Commit acc89db

Browse files
committed
DOC: update the docstring of the group_rank method pandas-dev#20561
1 parent f841ef8 commit acc89db

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

pandas/_libs/groupby_helper.pxi.in

+10-4
Original file line numberDiff line numberDiff line change
@@ -428,14 +428,20 @@ def group_rank_{{name}}(ndarray[float64_t, ndim=2] out,
428428
is_datetimelike : bool
429429
unused in this method but provided for call compatibility with other
430430
Cython transformations
431-
ties_method : {'keep', 'top', 'bottom'}
432-
* keep: leave NA values where they are
433-
* top: smallest rank if ascending
434-
* bottom: smallest rank if descending
431+
ties_method : {'average', 'min', 'max', 'first', 'dense'}
432+
* average: average rank of group
433+
* min: lowest rank in group
434+
* max: highest rank in group
435+
* first: ranks assigned in order they appear in the array
436+
* dense: like 'min', but rank always increases by 1 between groups
435437
ascending : boolean
436438
False for ranks by high (1) to low (N)
437439
pct : boolean
438440
Compute percentage rank of data within each group
441+
na_option : {'keep', 'top', 'bottom'}
442+
* keep: leave NA values where they are
443+
* top: smallest rank if ascending
444+
* bottom: smallest rank if descending
439445

440446
Notes
441447
-----

0 commit comments

Comments
 (0)