doeasyeda.create_hist_plot

Module Contents

Functions

create_hist_plot(df, x_col, y_col[, color, title, ...])

Creates a histogram using Altair with customizable options.
exception doeasyeda.create_hist_plot.DoEasyEDAException(message, original_exception)[source]

Bases: Exception

Common base class for all non-exit exceptions.

doeasyeda.create_hist_plot.create_hist_plot(df, x_col, y_col, color=None, title=None, x_title=None, y_title=None, tooltip=None, interactive=False, width=None, height=None)[source]

Creates a histogram using Altair with customizable options.

Parameters:

  • df (pd.DataFrame) – Dataframe containing the data for the histogram.

  • x_col (str) – The column name to be used for the x-axis.

  • y_col (str) – The column name to be used for the y-axis.

  • color (str, optional) – The column name to be used for color encoding (default is None).

  • title (str, optional) – The title of the scatter plot (default is None).

  • x_title (str, optional) – The title for the x-axis (default is None).

  • y_title (str, optional) – The title for the y-axis (default is None).

  • tooltip (list of str, optional) – List of column names to be used for tooltips (default is None).

  • interactive (bool, optional) – If True, enables interactive features like zooming and panning (default is False).

  • width (int, optional) – The width of the chart (default is None).

  • height (int, optional) – The height of the chart (default is None).

Returns:

An Altair Chart object representing the scatter plot.

Return type:

alt.Chart

Example

>>> data = pd.DataFrame({'category': ['A', 'A', 'B', 'B', 'C', 'C'],
...                      'value': [10, 15, 10, 20, 5, 25]})
>>> create_hist_plot(data, x_col='category', y_col='value', color='category',
...                  title='Histogram of Values by Category',
...                  x_title='Category', y_title='Value', interactive=True)