update func name for clarity

CDCgov · Jan 28, 2025 · e949796 · e949796
1 parent 4c4e6dd
commit e949796
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/forecasttools/__init__.py b/forecasttools/__init__.py
@@ -4,7 +4,7 @@
 import polars as pl
 
 from forecasttools.daily_to_epiweekly import df_aggregate_to_epiweekly
-from forecasttools.idata_to_tidy import convert_idata_forecast_to_tidydraws
+from forecasttools.idata_to_tidy import convert_inference_data_to_tidydraws
 from forecasttools.idata_w_dates_to_df import (
     add_time_coords_to_idata_dimension,
     add_time_coords_to_idata_dimensions,
@@ -96,5 +96,5 @@
     "generate_time_range_for_dim",
     "validate_iter_has_expected_types",
     "ensure_listlike",
-    "convert_idata_forecast_to_tidydraws"
+    "convert_inference_data_to_tidydraws"
 ]
diff --git a/forecasttools/idata_to_tidy.py b/forecasttools/idata_to_tidy.py
@@ -11,7 +11,7 @@
 import polars as pl
 
 
-def convert_idata_forecast_to_tidydraws(
+def convert_inference_data_to_tidydraws(
     idata: az.InferenceData,
     groups: list[str]
 ) -> dict[str, pl.DataFrame]:

diff --git a/notebooks/pyrenew_dates_to_tidy.qmd b/notebooks/pyrenew_dates_to_tidy.qmd
@@ -33,7 +33,7 @@ __Define Groups To Save And Convert__
 #| echo: true
 
 pyrenew_groups = ["posterior_predictive"]
-tidy_usable_groups = forecasttools.convert_idata_forecast_to_tidydraws(
+tidy_usable_groups = forecasttools.convert_inference_data_to_tidydraws(
     idata=pyrenew_idata,
     groups=pyrenew_groups
 )
@@ -88,7 +88,7 @@ __Again Convert The Dated Pyrenew InferenceData To Tidy-Usable__
 ```{python}
 
 pyrenew_groups = ["posterior_predictive"]
-tidy_usable_groups_w_dates = forecasttools.convert_idata_forecast_to_tidydraws(
+tidy_usable_groups_w_dates = forecasttools.convert_inference_data_to_tidydraws(
     idata=pyrenew_idata_w_dates,
     groups=pyrenew_groups
 )