Updating DataFrame.mode docstring.
#22404
Conversation
pandas/core/frame.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
| >>> df = pd.DataFrame({'A': [1, 2, 1, 2, 1, 2, 3]}) | ||
|
|
There was a problem hiding this comment.
Is it standard to have a newline after the section title?
There was a problem hiding this comment.
No, it's not, good catch. I added it to the TODO list for the validation script in #20298 (it happens very often).
Codecov Report
@@ Coverage Diff @@
## master #22404 +/- ##
=======================================
Coverage 92.18% 92.18%
=======================================
Files 169 169
Lines 50820 50820
=======================================
Hits 46850 46850
Misses 3970 3970
Continue to review full report at Codecov.
|
pandas/core/frame.py
Outdated
| dropna : boolean, default True | ||
| The axis to iterate over while searching for the mode. | ||
| To find the mode for each column, use ``axis='index'``. | ||
| To find the mode for each row, use ``axis='columns'``. |
There was a problem hiding this comment.
I like the first line of your summary. However, I would put back the two bullet points.
There was a problem hiding this comment.
Agree, fixed. And we should probably define a standard and be consistent when documenting axis (added it to #20298)
pandas/core/frame.py
Outdated
| spider arthropod 8 0.0 | ||
| ostrich bird 2 NaN | ||
|
|
||
| By default, missing values are not considered, and the mode of winds |
There was a problem hiding this comment.
Think you mean to say wings here and not winds; side note - ostriches do still have wings :-)
There was a problem hiding this comment.
NaN means unknown in this case, not zero, and I need missing values to show the behavior. But yeah, agree. ;)
pandas/core/frame.py
Outdated
| ostrich bird 2 NaN | ||
|
|
||
| By default, missing values are not considered, and the mode of winds | ||
| are both 0 and 2. The second row of species and legs contains NaN, |
pandas/core/frame.py
Outdated
|
|
||
| Notes | ||
| ----- | ||
| Every column or row of the resulting DataFrame contains all its modes. |
There was a problem hiding this comment.
May just be me but I don't understand the Notes section - is this necessary or better explained via examples?
| values with the mode in a dataframe ``df``, you can just do this: | ||
| ``df.fillna(df.mode().iloc[0])`` | ||
| The mode of a set of values is the value that appears most often. | ||
| It can be multiple values. |
There was a problem hiding this comment.
Can we add an example to show this?
There was a problem hiding this comment.
The first example shows this (wings has two modes)
| values with the mode in a dataframe ``df``, you can just do this: | ||
| ``df.fillna(df.mode().iloc[0])`` | ||
| The mode of a set of values is the value that appears most often. | ||
| It can be multiple values. |
There was a problem hiding this comment.
The first example shows this (wings has two modes)
pandas/core/frame.py
Outdated
| spider arthropod 8 0.0 | ||
| ostrich bird 2 NaN | ||
|
|
||
| By default, missing values are not considered, and the mode of winds |
There was a problem hiding this comment.
NaN means unknown in this case, not zero, and I need missing values to show the behavior. But yeah, agree. ;)
|
Hello @datapythonista! Thanks for updating the PR.
|
|
@WillAyd can you take a look and merged this, if the comments from your review are addressed correctly. Thanks! |
Supersedes #20241 (source branch does not exist anymore).