MMMPlotSuite.saturation_scatterplot#

MMMPlotSuite.saturation_scatterplot(original_scale=False, dims=None, apply_cost_per_unit=True, **kwargs)[source]#

Plot the saturation curves for each channel.

Creates a grid of subplots for each combination of channel and non-(date/channel) dimensions. Optionally, subset by dims (single values or lists). Each channel will have a consistent color across all subplots.

Parameters:
original_scalebool, default=False

If True, plot channel_contribution_original_scale instead of channel_contribution.

dimsdict[str, str | int | list], optional

Dimension filters. Example: {"country": ["US", "UK"]}.

apply_cost_per_unitbool, default=True

If True and cost-per-unit data is available, the x-axis shows spend (channel_data * cost_per_unit). If False, shows raw channel data.

**kwargs

Additional keyword arguments forwarded to the scatter plot.