geostep.visualizer.plot_lift_distribution

geostep.visualizer.plot_lift_distribution(analysis_df: DataFrame, assignment_col: str, lift_col: str = 'lift_index', save_path: str | None = None) → None

Plots the distribution of the lift index by group.

Parameters:

• analysis_df (pd.DataFrame) – The DataFrame containing the per-geo lift calculations. This is returned by the run_primary_analysis function.

• assignment_col (str) – The name of the column with group assignments.

• lift_col (str, optional) – The name of the lift index column, by default ‘lift_index’.

• save_path (str, optional) – If provided, saves the plot to this path. Otherwise, displays the plot.