skferm.plotting package#

Submodules#

skferm.plotting.curves module#

Plotting functions for fermentation curves.

plot_fermentation_curves(data: pd.DataFrame, sample_col: str = 'sample_id', x: str = 'x', y: str = 'y', title: str | None = None, xlabel: str | None = None, ylabel: str | None = None, figsize: Tuple[int, int] = (10, 6), style: Literal['white', 'dark', 'whitegrid', 'darkgrid', 'ticks'] = 'whitegrid', ax: 'Axes' | None = None, **kwargs)[source]#

Plot fermentation curves with different samples distinguished by color.

Parameters:
  • data (pd.DataFrame) – DataFrame containing fermentation data

  • sample_col (str, default 'sample_id') – Column name for sample identification

  • x (str, default 'x') – Column name for x-axis values

  • y (str, default 'y') – Column name for y-axis values

  • title (str, optional) – Plot title. If None, generates default title

  • xlabel (str, optional) – X-axis label. If None, uses x column name

  • ylabel (str, optional) – Y-axis label. If None, uses y column name

  • figsize (tuple, default (10, 6)) – Figure size as (width, height). Only used when ax is None

  • style (str, default 'whitegrid') – Seaborn style

  • ax (matplotlib.axes.Axes, optional) – Axes object to plot on. If None, creates new figure and axes

  • **kwargs (additional keyword arguments for seaborn.lineplot)

Returns:

Returns Figure if ax is None (new figure created), otherwise returns the provided Axes

Return type:

matplotlib.figure.Figure or matplotlib.axes.Axes

Module contents#

Plotting utilities for fermentation data visualization.

plot_fermentation_curves(data: pd.DataFrame, sample_col: str = 'sample_id', x: str = 'x', y: str = 'y', title: str | None = None, xlabel: str | None = None, ylabel: str | None = None, figsize: Tuple[int, int] = (10, 6), style: Literal['white', 'dark', 'whitegrid', 'darkgrid', 'ticks'] = 'whitegrid', ax: 'Axes' | None = None, **kwargs)[source]#

Plot fermentation curves with different samples distinguished by color.

Parameters:
  • data (pd.DataFrame) – DataFrame containing fermentation data

  • sample_col (str, default 'sample_id') – Column name for sample identification

  • x (str, default 'x') – Column name for x-axis values

  • y (str, default 'y') – Column name for y-axis values

  • title (str, optional) – Plot title. If None, generates default title

  • xlabel (str, optional) – X-axis label. If None, uses x column name

  • ylabel (str, optional) – Y-axis label. If None, uses y column name

  • figsize (tuple, default (10, 6)) – Figure size as (width, height). Only used when ax is None

  • style (str, default 'whitegrid') – Seaborn style

  • ax (matplotlib.axes.Axes, optional) – Axes object to plot on. If None, creates new figure and axes

  • **kwargs (additional keyword arguments for seaborn.lineplot)

Returns:

Returns Figure if ax is None (new figure created), otherwise returns the provided Axes

Return type:

matplotlib.figure.Figure or matplotlib.axes.Axes