Skip to content

DOC: fix PR07,SA01,ES01 for pandas.plotting.scatter_matrix #60572

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
Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
-i "pandas.plotting.andrews_curves RT03,SA01" \
-i "pandas.plotting.scatter_matrix PR07,SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
Expand Down
15 changes: 15 additions & 0 deletions pandas/plotting/_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,21 @@ def scatter_matrix(
"""
Draw a matrix of scatter plots.

Each pair of numeric columns in the DataFrame is plotted against each other,
resulting in a matrix of scatter plots. The diagonal plots can display either
histograms or Kernel Density Estimation (KDE) plots for each variable.

Parameters
----------
frame : DataFrame
The data to be plotted.
alpha : float, optional
Amount of transparency applied.
figsize : (float,float), optional
A tuple (width, height) in inches.
ax : Matplotlib axis object, optional
An existing Matplotlib axis object for the plots. If None, a new axis is
created.
grid : bool, optional
Setting this to True will show the grid.
diagonal : {'hist', 'kde'}
Expand All @@ -208,6 +215,14 @@ def scatter_matrix(
numpy.ndarray
A matrix of scatter plots.

See Also
--------
plotting.parallel_coordinates : Plots parallel coordinates for multivariate data.
plotting.andrews_curves : Generates Andrews curves for visualizing clusters of
multivariate data.
plotting.radviz : Creates a RadViz visualization.
plotting.bootstrap_plot : Visualizes uncertainty in data via bootstrap sampling.

Examples
--------

Expand Down
Loading