NHSDigital
diff --git a/‎codonPython/suppression.py‎
Lines changed: 23 additions & 41 deletions b/‎codonPython/suppression.py‎
Lines changed: 23 additions & 41 deletions
diff --git a/‎codonPython/tests/suppression_test.py‎
Lines changed: 5 additions & 5 deletions b/‎codonPython/tests/suppression_test.py‎
Lines changed: 5 additions & 5 deletions
@@ -1,67 +1,49 @@
-def round_value(valuein: int, base = 5)->int:
+def suppress_value(valuein: int, rc: str = '*', upper: int = 100000000)->str:
     """
-    Round values to nearest 5
+    Suppress values less than or equal to 7, round all non-national values.
 
-    This function will round metric values to the nearest 5.
-    
-    Parameters
-    ----------
-    valuein : int
-        Metric value
-    base :
-        number which we are rounding to i.e. to the nearest 5
-    
-    Returns
-    ----------
-    out : int
-        Rounded value 
-    
-    Examples
-    ----------
-    >>> round_value(8)
-    '10'
-    >>> round_value(20)
-    '20'
-    >>> round_value(46)
-    '45'
-    """
-
-    return base * round(valuein/base)
-
-def suppress_value(valuein: int, rc:str = '*')->str:
-    """
-    Suppress values less than or equal to 7
-
-    This function takes the metric value and suppresses it if it is less than or equal to 7. 
-    If the metric value is 0 then it will remain as 0.
+    This function suppresses value if it is less than or equal to 7.
+    If value is 0 then it will remain as 0.
+    If value is at national level it will remain unsuppressed.
+    All other values will be rounded to the nearest 5.
 
     Parameters
     ----------
     valuein : int
         Metric value
     rc : str
         Replacement character if value needs suppressing
+    upper : int
+        Upper limit for suppression of numbers
 
     Returns
     -------
     out : str
-        Suppressed value (*), 0 or valuein if greater than 7
+        Suppressed value (*), 0 or valuein if greater than 7 or national
 
     Examples
     --------
     >>> suppress_value(3)
     '*'
     >>> suppress_value(24)
-    '24'
+    '25'
     >>> suppress_value(0)
     '0'
     """
+    base = 5
+
+    if not isinstance(valuein, int):
+        raise ValueError("The input: {} is not an integer.".format(valuein))
 
-    if valuein == 0:
+    if valuein < 0:
+        raise ValueError("The input: {} is less than 0.".format(valuein))
+    elif valuein == 0:
         valueout = str(valuein)
-    if 1 <= valuein <= 7:
+    elif valuein >= 1 and valuein <= 7:
         valueout = rc
-    if valuein > 7:
-        valueout = str(valuein)
+    elif valuein > 7 and valuein <= upper:
+        valueout = str(base * round(valuein/base))
+    else:
+        raise ValueError(
+            "The input: {} is greater than: {}.".format(valuein, upper))
     return valueout
-  
@@ -3,13 +3,13 @@
 
 
 @pytest.mark.parametrize("to_suppress, expected", [
-    (0, 0),
+    (0, "0"),
     (2, "*"),
     (5, "*"),
-    (8, 10),
-    (16, 15),
-    (57, 60),
-    (10023, 10025)
+    (8, "10"),
+    (16, "15"),
+    (57, "55"),
+    (10023, "10025")
 ])
 def test_suppress_value_BAU(to_suppress, expected):
     assert expected == suppress_value(to_suppress)