add unit tests for normalisation flag

Author: joshuabmoore

pyspi/calculator.py

@@ -34,7 +34,7 @@ class Calculator:
             A pre-configured subset of SPIs to use. Options are "all", "fast", "sonnet", or "fabfour", defaults to "all".
         configfile (str, optional):
             The location of the YAML configuration file for a user-defined subset. See :ref:`Using a reduced SPI set`, defaults to :code:`'</path/to/pyspi>/pyspi/config.yaml'`
-        normalise (nool, optional):
+        normalise (bool, optional):
             Normalise the dataset along the time axis before computing SPIs, defaults to True.
     """
     _optional_dependencies = None

pyspi/data.py

@@ -183,6 +183,8 @@ def set_data(
                 data = detrend(data, axis=1)
             except ValueError as err:
                 print(f"Could not detrend data: {err}")
+        else:
+            print("Skipping normalisation of the dataset...\n")
 
         nans = np.isnan(data)
         if nans.any():

tests/test_calc.py

@@ -284,7 +284,6 @@ def test_calculator_frame_normal_operation():
     # check that compute runs
     calc_frame.compute()
 
-
 def test_correlation_frame_normal_operation():
     """Test whether the correlation frame instantiates as expected.""" 
     datasets = [np.random.randn(3, 100) for _ in range(3)]
@@ -297,3 +296,13 @@ def test_correlation_frame_normal_operation():
     cf = calc_frame.get_correlation_df()
 
     assert not(cf[0].empty), "Correlation frame is empty."
+
+def test_normalisation_flag():
+    """Test whether the normalisation flag when instantiating
+    the calculator works as expected."""
+    data = np.random.randn(3, 100)
+    calc = Calculator(dataset=data, normalise=False)
+    calc_loaded_dataset = calc.dataset.to_numpy().squeeze()
+    
+    assert (calc_loaded_dataset == data).all(), f"Calculator normalise=False not producing the correct output." 
+