Skip to content

DOC: Fix EX01 in pandas.DataFrame.idxmax #32551

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 3 commits into from
Mar 11, 2020
Merged

DOC: Fix EX01 in pandas.DataFrame.idxmax #32551

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9530c93
DOC: Fix EX01 in pandas.DataFrame.idxmax
farhanreynaldo Mar 9, 2020
d0b18da
Merge branch 'master' of https://github.com/pandas-dev/pandas into df…
farhanreynaldo Mar 10, 2020
0c872b3
Fix grammatical errors
farhanreynaldo Mar 10, 2020
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
29 changes: 29 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8029,6 +8029,35 @@ def idxmax(self, axis=0, skipna=True) -> Series:
Notes
-----
This method is the DataFrame version of ``ndarray.argmax``.

Examples
--------
Consider dataset containing food consumption in Argentina.
Copy link
Member

Choose a reason for hiding this comment

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

    Consider a dataset containing food consumption in Argentina.


>>> df = pd.DataFrame({'consumption': [10.51, 103.11, 55.48],
... 'co2_emission': [37.2, 19.66, 1712]},
Copy link
Member

Choose a reason for hiding this comment

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

    ...                    'co2_emissions': [37.2, 19.66, 1712]},

(this will have to change in the other parts too)

... index=['Pork', 'Wheat Products', 'Beef'])

>>> df
consumption co2_emission
Pork 10.51 37.20
Wheat Products 103.11 19.66
Beef 55.48 1712.00

By default, it returns index for the maximum value in each columns.
Copy link
Member

Choose a reason for hiding this comment

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

    By default, it returns the index for the maximum value in each column.


>>> df.idxmax()
consumption Wheat Products
co2_emission Beef
dtype: object

To return index for the maximum value in each rows, use ``axis="columns"``.
Copy link
Member

Choose a reason for hiding this comment

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

    To return the index for the maximum value in each row, use ``axis="columns"``.


>>> df.idxmax(axis="columns")
Pork co2_emission
Wheat Products consumption
Beef co2_emission
dtype: object
"""
axis = self._get_axis_number(axis)
indices = nanops.nanargmax(self.values, axis=axis, skipna=skipna)
Expand Down