Rename snowballing to snowball

This aligns better with the other arguments.

Author: PeterLombaers

asreviewcontrib/datatools/entrypoint.py

@@ -9,8 +9,8 @@
 from asreviewcontrib.datatools.convert import convert
 from asreviewcontrib.datatools.describe import _parse_arguments_describe
 from asreviewcontrib.datatools.describe import describe
-from asreviewcontrib.datatools.snowballing import _parse_arguments_snowballing
-from asreviewcontrib.datatools.snowballing import snowballing
+from asreviewcontrib.datatools.snowball import _parse_arguments_snowball
+from asreviewcontrib.datatools.snowball import snowball
 from asreviewcontrib.datatools.stack import _parse_arguments_vstack
 from asreviewcontrib.datatools.stack import vstack
 
@@ -98,9 +98,9 @@ def execute(self, argv):
                     resolve=args_compose.conflict_resolve,
                 )
             if argv[0] == "snowballing":
-                args_snowballing_parser = _parse_arguments_snowballing()
+                args_snowballing_parser = _parse_arguments_snowball()
                 args_snowballing = vars(args_snowballing_parser.parse_args(argv[1:]))
-                snowballing(**args_snowballing)
+                snowball(**args_snowballing)
             if argv[0] == "vstack":
                 args_vstack_parser = _parse_arguments_vstack()
                 args_vstack = args_vstack_parser.parse_args(argv[1:])

asreviewcontrib/datatools/snowballing.py asreviewcontrib/datatools/snowball.py

@@ -168,7 +168,7 @@ def openalex_from_doi(dois: list[str]) -> dict[str, str]:
     return id_mapping
 
 
-def snowballing(
+def snowball(
     input_path: Path,
     output_path: Path,
     forward: bool,
@@ -266,7 +266,7 @@ def snowballing(
     print("Saved dataset")
 
 
-def _parse_arguments_snowballing():
+def _parse_arguments_snowball():
     parser = argparse.ArgumentParser(prog="asreview data snowballing")
     parser.add_argument(
         "input_path", type=str, help="The file path of the input dataset."

tests/test_snowballing.py tests/test_snowball.py

@@ -2,10 +2,10 @@
 
 import pandas as pd
 
-from asreviewcontrib.datatools.snowballing import backward_snowballing
-from asreviewcontrib.datatools.snowballing import forward_snowballing
-from asreviewcontrib.datatools.snowballing import openalex_from_doi
-from asreviewcontrib.datatools.snowballing import snowballing
+from asreviewcontrib.datatools.snowball import backward_snowballing
+from asreviewcontrib.datatools.snowball import forward_snowballing
+from asreviewcontrib.datatools.snowball import openalex_from_doi
+from asreviewcontrib.datatools.snowball import snowball
 
 INPUT_DIR = Path(__file__).parent / "demo_data"
 
@@ -58,7 +58,7 @@ def test_forward_snowballing():
 
 def test_openalex_id_forward(tmpdir):
     out_fp = Path(tmpdir, "forward_all.csv")
-    snowballing(
+    snowball(
         input_path=INPUT_DIR / "snowballing_openalex.csv",
         output_path=out_fp,
         forward=True,
@@ -69,7 +69,7 @@ def test_openalex_id_forward(tmpdir):
     assert len(df) >= 23
 
     all_out_fp = Path(tmpdir, "forward_all.csv")
-    snowballing(
+    snowball(
         input_path=INPUT_DIR / "snowballing_openalex.csv",
         output_path=all_out_fp,
         forward=True,
@@ -82,7 +82,7 @@ def test_openalex_id_forward(tmpdir):
 
 def test_openalex_id_backward(tmpdir):
     out_fp = Path(tmpdir, "forward_all.csv")
-    snowballing(
+    snowball(
         input_path=INPUT_DIR / "snowballing_openalex.csv",
         output_path=out_fp,
         forward=False,
@@ -93,7 +93,7 @@ def test_openalex_id_backward(tmpdir):
     assert len(df) == 31
 
     all_out_fp = Path(tmpdir, "backward_all.csv")
-    snowballing(
+    snowball(
         input_path=INPUT_DIR / "snowballing_openalex.csv",
         output_path=all_out_fp,
         forward=False,
@@ -106,7 +106,7 @@ def test_openalex_id_backward(tmpdir):
 
 def test_snowballing_from_doi(tmpdir):
     out_fp = Path(tmpdir, "doi_all.csv")
-    snowballing(
+    snowball(
         input_path=INPUT_DIR / "snowballing_doi.csv",
         output_path=out_fp,
         forward=False,