Skip to content

DOC: update the pandas.DataFrame.hist docstring #20113

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 2 commits into from
Mar 13, 2018
Merged
Changes from all commits
Commits
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
65 changes: 48 additions & 17 deletions pandas/plotting/_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -2128,50 +2128,81 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None,
xrot=None, ylabelsize=None, yrot=None, ax=None, sharex=False,
sharey=False, figsize=None, layout=None, bins=10, **kwds):
"""
Draw histogram of the DataFrame's series using matplotlib / pylab.
Make a histogram of the DataFrame's.

A `histogram`_ is a representation of the distribution of data.
This function calls :meth:`matplotlib.pyplot.hist`, on each series in
the DataFrame, resulting in one histogram per column.

.. _histogram: https://en.wikipedia.org/wiki/Histogram

Parameters
----------
data : DataFrame
The pandas object holding the data.
column : string or sequence
If passed, will be used to limit data to a subset of columns
If passed, will be used to limit data to a subset of columns.
by : object, optional
If passed, then used to form histograms for separate groups
If passed, then used to form histograms for separate groups.
grid : boolean, default True
Whether to show axis grid lines
Whether to show axis grid lines.
xlabelsize : int, default None
If specified changes the x-axis label size
If specified changes the x-axis label size.
xrot : float, default None
rotation of x axis labels
Rotation of x axis labels. For example, a value of 90 displays the
x labels rotated 90 degrees clockwise.
ylabelsize : int, default None
If specified changes the y-axis label size
If specified changes the y-axis label size.
yrot : float, default None
rotation of y axis labels
ax : matplotlib axes object, default None
Rotation of y axis labels. For example, a value of 90 displays the
y labels rotated 90 degrees clockwise.
ax : Matplotlib axes object, default None
The axes to plot the histogram on.
sharex : boolean, default True if ax is None else False
In case subplots=True, share x axis and set some x axis labels to
invisible; defaults to True if ax is None otherwise False if an ax
is passed in; Be aware, that passing in both an ax and sharex=True
will alter all x axis labels for all subplots in a figure!
is passed in.
Note that passing in both an ax and sharex=True will alter all x axis
labels for all subplots in a figure.
sharey : boolean, default False
In case subplots=True, share y axis and set some y axis labels to
invisible
invisible.
figsize : tuple
The size of the figure to create in inches by default
The size in inches of the figure to create. Uses the value in
`matplotlib.rcParams` by default.
layout : tuple, optional
Tuple of (rows, columns) for the layout of the histograms
Tuple of (rows, columns) for the layout of the histograms.
bins : integer or sequence, default 10
Number of histogram bins to be used. If an integer is given, bins + 1
bin edges are calculated and returned. If bins is a sequence, gives
bin edges, including left edge of first bin and right edge of last
bin. In this case, bins is returned unmodified.
`**kwds` : other plotting keyword arguments
To be passed to hist function
**kwds
All other plotting keyword arguments to be passed to
:meth:`matplotlib.pyplot.hist`.

Returns
-------
axes : matplotlib.AxesSubplot or numpy.ndarray of them

See Also
--------
matplotlib.axes.Axes.hist : Plot a histogram using matplotlib.
matplotlib.pyplot.hist : Plot a histogram using matplotlib.

Examples
--------

.. plot::
:context: close-figs

This example draws a histogram based on the length and width of
some animals, displayed in three bins

>>> df = pd.DataFrame({
... 'length': [1.5, 0.5, 1.2, 0.9, 3],
... 'width': [0.7, 0.2, 0.15, 0.2, 1.1]
... }, index= ['pig', 'rabbit', 'duck', 'chicken', 'horse'])
>>> hist = df.hist(bins=3)
"""
_converter._WARN = False
if by is not None:
Expand Down