Merge pull request #90 from ONSdigital/spp_5901_rename_methods

Spp 5901 rename methods

Author: vidhyamanisankar

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "statistical_methods_library"
-version = "4.5.0"
+version = "5.0.0"
 description = ""
 authors = ["Your Name <you@example.com>"]
 license = "MIT"

statistical_methods_library/estimation.py

@@ -16,7 +16,7 @@ class ValidationError(Exception):
     pass
 
 
-def estimate(
+def ht_ratio(
     input_df: DataFrame,
     unique_identifier_col: str,
     period_col: str,
@@ -33,8 +33,8 @@ def estimate(
     calibration_weight_col: typing.Optional[str] = "calibration_weight",
 ) -> DataFrame:
     """
-    Perform estimation of design and calibration weights using Expansion and
-    Ratio estimation.
+    Perform Horvitz-Thompson estimation of design and calibration weights
+    using Expansion and Ratio estimation.
 
     ###Arguments
     * `input_df`: The input data frame.