-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: update the pandas.DataFrame.plot.bar docsctring #20158
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.
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
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a2b2e24
Bar plot documentation with examples
miquelcamprodon 209d8a0
Bar plot documentation with examples
miquelcamprodon b231f36
Bar plot documentation with examples
miquelcamprodon c6e6ca2
Adapting to reviewers comments. Added default behaviour
miquelcamprodon d3595e5
Merge with master
miquelcamprodon 09065f8
Grammar.
TomAugspurger 1892d35
Subplots
TomAugspurger a5897d5
Update _core.py
miquelcamprodon 18fc6e2
Update _core.py
jorisvandenbossche File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2835,19 +2835,86 @@ def line(self, x=None, y=None, **kwds): | |
|
||
def bar(self, x=None, y=None, **kwds): | ||
""" | ||
Vertical bar plot | ||
Vertical bar plot. | ||
|
||
A bar plot is a plot that presents categorical data with | ||
rectangular bars with lengths proportional to the values that they | ||
represent. A bar plot shows comparisons among discrete categories. One | ||
axis of the plot shows the specific categories being compared, and the | ||
other axis represents a measured value. | ||
|
||
Parameters | ||
---------- | ||
x, y : label or position, optional | ||
Coordinates for each point. | ||
`**kwds` : optional | ||
x : label or position, optional | ||
Allows plotting of one column versus another. If not specified, | ||
the index of the DataFrame is use. | ||
y : label or position, optional | ||
Allows plotting of one column versus another. If not specified, | ||
all numerical columns are used. | ||
**kwds : optional | ||
Additional keyword arguments are documented in | ||
:meth:`pandas.DataFrame.plot`. | ||
|
||
Returns | ||
------- | ||
axes : :class:`matplotlib.axes.Axes` or numpy.ndarray of them | ||
axes : matplotlib.axes.Axes or np.ndarray of them | ||
An ndarray is returned with one :class:`matplotlib.axes.Axes` | ||
per column when ``subplots=True``. | ||
|
||
See Also | ||
-------- | ||
pandas.DataFrame.plot.barh : Horizontal bar plot. | ||
pandas.DataFrame.plot : Make plots of DataFrame using matplotlib. | ||
matplotlib.pyplot.bar : Make a bar plot with matplotlib. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The empty line here is not necessary. |
||
Examples | ||
-------- | ||
Basic plot. | ||
|
||
.. plot:: | ||
:context: close-figs | ||
|
||
>>> df = pd.DataFrame({'lab':['A', 'B', 'C'], 'val':[10, 30, 20]}) | ||
>>> ax = df.plot.bar(x='lab', y='val', rot=0) | ||
|
||
Plot a whole dataframe to a bar plot. Each column is assigned a | ||
distinct color, and each row is nested in a group along the | ||
horizontal axis. | ||
|
||
.. plot:: | ||
:context: close-figs | ||
|
||
>>> speed = [0.1, 17.5, 40, 48, 52, 69, 88] | ||
>>> lifespan = [2, 8, 70, 1.5, 25, 12, 28] | ||
>>> index = ['snail', 'pig', 'elephant', | ||
... 'rabbit', 'giraffe', 'coyote', 'horse'] | ||
>>> df = pd.DataFrame({'speed': speed, | ||
... 'lifespan': lifespan}, index=index) | ||
>>> ax = df.plot.bar(rot=0) | ||
|
||
Instead of nesting, the figure can be split by column with | ||
``subplots=True``. In this case, a :class:`numpy.ndarray` of | ||
:class:`matplotlib.axes.Axes` are returned. | ||
|
||
.. plot:: | ||
:context: close-figs | ||
|
||
>>> axes = df.plot.bar(rot=0, subplots=True) | ||
>>> axes[1].legend(loc=2) # doctest: +SKIP | ||
|
||
Plot a single column. | ||
|
||
.. plot:: | ||
:context: close-figs | ||
|
||
>>> ax = df.plot.bar(y='speed', rot=0) | ||
|
||
Plot only selected categories for the DataFrame. | ||
|
||
.. plot:: | ||
:context: close-figs | ||
|
||
>>> ax = df.plot.bar(x='lifespan', rot=0) | ||
""" | ||
return self(kind='bar', x=x, y=y, **kwds) | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In our case it worked with
kwds
instead of**kwds
.https://github.com/pandas-dev/pandas/pull/20152/files#diff-2b118bda866f3d626ceb6b529c62cd1aR1977