Rename compute_clustered_binomial_gee_group_statistics to compute_binomial_gee_group_statistics for consistency

Author: FabrizioMusacchio

docs/source/api.rst

@@ -125,7 +125,7 @@ Metric tables
 .. autofunction:: compute_threshold_responder_table
 .. autofunction:: compute_responder_group_statistics
 .. autofunction:: compute_binomial_glm_group_statistics
-.. autofunction:: compute_clustered_binomial_gee_group_statistics
+.. autofunction:: compute_binomial_gee_group_statistics
 .. autofunction:: compute_group_day_violin_statistics
 .. autofunction:: compute_role_cumulative_curves
 .. autofunction:: compute_time_window_learning_curves

ic_analysis/metrics.py

@@ -1424,7 +1424,7 @@ def compute_binomial_glm_group_statistics(
 
     return pd.DataFrame(omnibus_rows), pd.DataFrame(pairwise_rows)
 
-def compute_clustered_binomial_gee_group_statistics(
+def compute_binomial_gee_group_statistics(
     data: pd.DataFrame,
     *,
     phase_number: int,
@@ -1560,6 +1560,11 @@ def compute_clustered_binomial_gee_group_statistics(
 
     return pd.DataFrame(omnibus_rows), pd.DataFrame(pairwise_rows)
 
+
+# Backward-compatible alias for the original public function name.
+compute_clustered_binomial_gee_group_statistics = compute_binomial_gee_group_statistics
+
+
 def _fdr_bh_adjust(p_values: list[float]) -> list[float]:
     """Apply Benjamini-Hochberg FDR correction to a sequence of p-values."""
 

ic_analysis/workflows/place_learning_reversal.py

@@ -52,7 +52,7 @@
     compute_awake_day_error_rate_tables,
     compute_awake_day_ratio_tables,
     compute_binomial_glm_group_statistics,
-    compute_clustered_binomial_gee_group_statistics,
+    compute_binomial_gee_group_statistics,
     compute_experiment_drinking_visit_bins,
     compute_experiment_lick_count_bins,
     compute_experiment_nosepoke_count_bins,
@@ -595,14 +595,14 @@ def _build_pl_rewarded_gee_stats(
         & hourly["bin_start_hours"].lt(24.0)
     ].copy()
 
-    day1_omnibus, day1_pairwise = compute_clustered_binomial_gee_group_statistics(
+    day1_omnibus, day1_pairwise = compute_binomial_gee_group_statistics(
         day1_awake,
         phase_number=3,
         metric_name=f"rewarded_correct_corner_day1awake_gee_{int(bin_hours)}h",
         success_col="correct_visits",
         total_col="all_visits",
     )
-    first24_omnibus, first24_pairwise = compute_clustered_binomial_gee_group_statistics(
+    first24_omnibus, first24_pairwise = compute_binomial_gee_group_statistics(
         first24h,
         phase_number=3,
         metric_name=f"rewarded_correct_corner_first24h_gee_{int(bin_hours)}h",

tests/test_metrics.py

@@ -10,7 +10,7 @@
     compute_awake_day_rate_tables,
     compute_awake_day_ratio_tables,
     compute_binomial_glm_group_statistics,
-    compute_clustered_binomial_gee_group_statistics,
+    compute_binomial_gee_group_statistics,
     compute_bottle_preference_bins,
     compute_experiment_drinking_visit_bins,
     compute_experiment_lick_count_bins,
@@ -290,7 +290,7 @@ def test_onset_responder_and_statistical_metrics(aligned_visits) -> None:
         phase_number=3,
         bin_hours=6,
         success_col="rewarded_correct_corner_visit")
-    gee_omnibus, gee_pairwise = compute_clustered_binomial_gee_group_statistics(
+    gee_omnibus, gee_pairwise = compute_binomial_gee_group_statistics(
         binned_mouse,
         phase_number=3,
         metric_name="rewarded_correct_corner_6h",
@@ -407,7 +407,7 @@ def test_empty_inputs_return_empty_tables(aligned_visits) -> None:
         metric_name="empty",
         success_col="correct_visits",
         total_col="all_visits")[0].empty
-    assert compute_clustered_binomial_gee_group_statistics(
+    assert compute_binomial_gee_group_statistics(
         pd.DataFrame(),
         phase_number=3,
         metric_name="empty",