refactor: Rename update_mappings() to merge_mappings()

VIDA-NYU · Jul 24, 2024 · 8fb62c4 · 8fb62c4
1 parent b87f980
commit 8fb62c4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/bdikit/api.py b/bdikit/api.py
@@ -463,7 +463,7 @@ class ColumnMappingSpec(TypedDict):
     mapper: ValueMapper
 
 
-def update_mappings(
+def merge_mappings(
     mappings: MappingSpecLike, user_mappings: Optional[MappingSpecLike] = None
 ) -> List:
     """
@@ -704,7 +704,7 @@ def create_mapper(
 
     if isinstance(input, Dict):
         if all(k in input for k in ["source", "target"]):
-            # This could be the mapper created by update_mappings() or a
+            # This could be the mapper created by merge_mappings() or a
             # specification defined by the user
             if "mapper" in input:
                 if isinstance(input["mapper"], ValueMapper):

diff --git a/examples/getting-started.ipynb b/examples/getting-started.ipynb
@@ -2733,7 +2733,7 @@
    "source": [
     "### Combining custom user mappings with suggested mappings\n",
     "\n",
-    "Before generating a final harmonized dataset, we can combine the automatically generated value mappings with the fixed mappings provided by the user. To do so, we use `bdi.update_mappings()` function, which take a list of mappings (e.g., generated automatically) and a list of \"user-defined mapping overrides\" that will be combined with the first list of mappings and will take precedence whenever they conflict.\n",
+    "Before generating a final harmonized dataset, we can combine the automatically generated value mappings with the fixed mappings provided by the user. To do so, we use `bdi.merge_mappings()` function, which take a list of mappings (e.g., generated automatically) and a list of \"user-defined mapping overrides\" that will be combined with the first list of mappings and will take precedence whenever they conflict.\n",
     "\n",
     "In our example below, all mappings specified in the variable `user_mappings` will override the mappings in `value_mappings` generated by the `bdi.match_values()` function."
    ]
@@ -2787,7 +2787,7 @@
     "]\n",
     "\n",
     "\n",
-    "harmonization_spec = bdi.update_mappings(value_mappings, user_mappings)\n"
+    "harmonization_spec = bdi.merge_mappings(value_mappings, user_mappings)\n"
    ]
   },
   {

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -239,17 +239,17 @@ def test_end_to_end_api_integration():
     assert "tgt_column" in df_mapped.columns
     assert df_mapped["tgt_column"].tolist() == ["apple", "banana", "orange", None]
 
-    # when: pass output of match_values() to update_mappings() and then to
+    # when: pass output of match_values() to merge_mappings() and then to
     # materialize_mapping()
-    harmonization_spec = bdi.update_mappings(value_mappings, [])
+    harmonization_spec = bdi.merge_mappings(value_mappings, [])
     df_mapped = bdi.materialize_mapping(df_source, harmonization_spec)
 
     # then: the column must be ranamed and values must be mapped
     assert isinstance(df_mapped, pd.DataFrame)
     assert "tgt_column" in df_mapped.columns
     assert df_mapped["tgt_column"].tolist() == ["apple", "banana", "orange", None]
 
-    # when: user mappings are specified in update_mappings()
+    # when: user mappings are specified in merge_mappings()
     user_mappings = [
         {
             "source": "src_column",
@@ -261,7 +261,7 @@ def test_end_to_end_api_integration():
             ],
         }
     ]
-    harmonization_spec = bdi.update_mappings(value_mappings, user_mappings)
+    harmonization_spec = bdi.merge_mappings(value_mappings, user_mappings)
     df_mapped = bdi.materialize_mapping(df_source, harmonization_spec)
 
     # then: user mappings take precedence, so the column must be ranamed and