beautifulplots.scatterplot

Module Contents

Functions

scatterplot(df, x, y[, ax, test_mode])

Scatterplot function.
beautifulplots.scatterplot.scatterplot(df, x, y, ax=None, test_mode=False, **kwargs)[source]

Scatterplot function. The underlying barplot is ased on the Seaborn with additions, such as data labels, and improved default parameters. Refer to beautifulplots plot_defaults for a complete list of options.

Parameters

  • df (DataFrame) – The input DataFrame containing colums corresponding to bar_plot values (“bar_values”) and column names (see examples in documentation)

  • x – Dataframe column corresponding to the x-axis

  • y – Column or list of columns corresponding to the y-axis

  • ax (axis) – matplotlib axis (optional), default = None. If axis is None, then create a matplolib figure, axis to host the barplot

  • color – default = None (Matplotlib default). Matplotlib compatabile color name as text or RGB values, for example, color = [51/235,125/235,183/235].

  • palette – Matplotlib compatible color palette name, for example, “tab20”

  • hue – Name of hue dimension variable (i.e., DataFrame column name)

  • options (additional) – see beautifulplot.plot_defaults for additional input variables.

Returns

returns True if processing completes succesfully (without errors).