data_describe.core.scatter

scatter_plots(data, mode=’matrix’, sample=None, threshold=None, compute_backend=None, viz_backend=None, **kwargs)

Scatter plots of numeric data.
class data_describe.core.scatter.ScatterWidget(input_data=None, num_data=None, mode=None, sample=None, diagnostics=None, threshold=None, compute_backend=None, viz_backend=None, **kwargs)

Bases: data_describe._widget.BaseWidget

Container for scatter plots.

This class (object) is returned from the scatter_plots function. The attributes documented below can be accessed or extracted.

input_data

The input data.

num_data

Numeric data only

mode

{‘diagnostic’, ‘matrix’, ‘all’} The visualization mode. diagnostic: Plots selected by scagnostics (scatter plot diagnostics) matrix: Generate the full scatter plot matrix all: Generate all individual scatter plots

sample

The sampling method to use. Currently not used.

diagnostics

The diagnostics from pyscagnostics.scagnostics

threshold

The scatter plot diagnostic threshold value [0,1] for returning a plot. Only used with “diagnostic” mode. For example, {"Outlying": 0.9} returns plots with outlier metrics above 0.9. See pyscagnostics.measure_names for a list of metrics. If a number: Returns all plots where at least one metric is above this threshold If a dictionary: Returns plots where the metric is above its threshold.

show(self, viz_backend=None, **kwargs)

The default display for this output.

Displays a scatter plot matrix.

Parameters

  • viz_backend – The visualization backend.

  • **kwargs – Keyword arguments.

Raises

ValueError – No numeric data to plot.

Returns

The correlation matrix plot.

data_describe.core.scatter.scatter_plots(data, mode='matrix', sample=None, threshold=None, compute_backend=None, viz_backend=None, **kwargs)

Scatter plots of numeric data.

Parameters

  • data – A Pandas data frame

  • mode (str) –

    {diagnostic, matrix, all} The visualization mode.

    • diagnostic: Plots selected by scagnostics (scatter plot diagnostics)

    • matrix: Generate the full scatter plot matrix

    • all: Generate all individual scatter plots

  • sample – The sampling method to use. Currently not used.

  • threshold –

    The scatter plot diagnostic threshold value [0,1] for returning a plot. Only used with “diagnostic” mode. For example, {"Outlying": 0.9} returns plots with outlier metrics above 0.9. See pyscagnostics.measure_names for a list of metrics.

    • If a number: Returns all plots where at least one metric is above this threshold

    • If a dictionary: Returns plots where the metric is above its threshold.

  • compute_backend – The compute backend

  • viz_backend – The vizualization backend

  • **kwargs – Passed to the visualization framework

Raises

ValueError – Invalid input data type.

Returns

Scatter plot.