static#

Utility functions for static plotting.

Functions

plot(data, x_bounds, y_bounds, marginals, ...)

Plot the dataset and summary statistics.

data_morph.plotting.static.plot(data: pd.DataFrame, x_bounds: Iterable[Number], y_bounds: Iterable[Number], marginals: tuple[tuple[np.ndarray, np.ndarray], tuple[np.ndarray, np.ndarray]] | None, save_to: str | Path, decimals: int, with_median: bool, **save_kwds: Any) → Axes | None[source]#

Plot the dataset and summary statistics.

Parameters:

data (pandas.DataFrame) – The dataset to plot.
x_bounds (Iterable[numbers.Number]) – The plotting limits.
y_bounds (Iterable[numbers.Number]) – The plotting limits.
marginals (tuple[tuple[np.ndarray, np.ndarray], tuple[np.ndarray, np.ndarray]] | None) – The counts per bin and bin boundaries for generating marginal plots.
save_to (str or pathlib.Path) – Path to save the plot frame to.
decimals (int) – The number of integers to highlight as preserved.
with_median (bool) – Whether to include the median.
**save_kwds – Additional keyword arguments that will be passed down to matplotlib.figure.Figure.savefig().

Returns:

When save_to is falsey, an Axes object is returned.

Return type:

matplotlib.axes.Axes or None