Histogram

simple_histogram(data, show_legend=True, opacity=0.75, title='Histogram', x_label='x', y_label='y', size=None, plotly_kwargs=None, show=True, write_html_path=None)

Create a simple histogram from a pandas DataFrame, numpy array, or list of values.

Example:

import numpy as np
from blitzly.plots.histogram import simple_histogram

foo = np.random.randn(500)
bar = np.random.randn(500) + 1
data = np.array([foo, bar])

simple_histogram(
    data,
    title="Histogram of foo and bar",
    x_label="Value",
    y_label="Count",
    write_html_path="the_blitz.html"
)

Parameters:

Name	Type	Description	Default
data	Union[pd.DataFrame, pd.Series, NDArray]	The data which should be plotted. Either one or multiple columns of data.	required
show_legend	Optional[bool]	Whether to show the legend.	True
opacity	Optional[float]	The opacity of the histogram.	0.75
title	Optional[str]	The title of the histogram.	'Histogram'
x_label	Optional[str]	The label of the x-axis.	'x'
y_label	Optional[str]	The label of the y-axis.	'y'
size	Optional[Tuple[int, int]	Size of the plot.	None
plotly_kwargs	Optional[dict]	Additional keyword arguments to pass to Plotly Histogram.	None
show	bool	Whether to show the figure.	True
write_html_path	Optional[str]	The path to which the histogram should be written as an HTML file. If None, the histogram will not be saved.	None

Source code in blitzly/plots/histogram.py

def simple_histogram(
    data: Union[pd.DataFrame, pd.Series, NDArray],
    show_legend: bool = True,
    opacity: float = 0.75,
    title: str = "Histogram",
    x_label: str = "x",
    y_label: str = "y",
    size: Optional[Tuple[int, int]] = None,
    plotly_kwargs: Optional[dict] = None,
    show: bool = True,
    write_html_path: Optional[str] = None,
) -> BaseFigure:
    """Create a simple histogram from a pandas DataFrame, numpy array, or list
    of values.

    Example:
    ```python
    import numpy as np
    from blitzly.plots.histogram import simple_histogram

    foo = np.random.randn(500)
    bar = np.random.randn(500) + 1
    data = np.array([foo, bar])

    simple_histogram(
        data,
        title="Histogram of foo and bar",
        x_label="Value",
        y_label="Count",
        write_html_path="the_blitz.html"
    )
    ```

    Args:
        data (Union[pd.DataFrame, pd.Series, NDArray]): The data which should be plotted.
            Either one or multiple columns of data.
        show_legend (Optional[bool]): Whether to show the legend.
        opacity (Optional[float]): The opacity of the histogram.
        title (Optional[str]): The title of the histogram.
        x_label (Optional[str]): The label of the x-axis.
        y_label (Optional[str]): The label of the y-axis.
        size (Optional[Tuple[int, int]): Size of the plot.
        plotly_kwargs (Optional[dict]): Additional keyword arguments to pass to Plotly `Histogram`.
        show (bool): Whether to show the figure.
        write_html_path (Optional[str]): The path to which the histogram should be written as an HTML file.
            If None, the histogram will not be saved.
    """

    data = check_data(data)

    if data.ndim == 1:
        data = [data]
    else:
        data = data.T

    fig = go.Figure()
    for d in data:
        fig.add_trace(go.Histogram(x=d, **plotly_kwargs if plotly_kwargs else {}))

    fig.update_layout(barmode="overlay")
    fig.update_xaxes(title_text=x_label)
    fig.update_yaxes(title_text=y_label)
    fig.update_traces(opacity=opacity)

    fig = update_figure_layout(fig, title, size, show_legend)

    return save_show_return(fig, write_html_path, show)