update documentation

Author: joshuabmoore

pyspi/calculator.py

@@ -16,7 +16,7 @@
 class Calculator:
     """Compute all pairwise interactions.
 
-    The calculator takes in a multivariate time-series dataset, computes and stores all pairwise interactions for the dataset.
+    The calculator takes in a multivariate time-series dataset (MTS), computes and stores all pairwise interactions for the dataset.
     It uses a YAML configuration file that can be modified in order to compute a reduced set of pairwise methods.
 
     Example:
@@ -37,9 +37,9 @@ class Calculator:
         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'`
         detrend (bool, optional):
-            If True, detrend each time series in the MTS dataset individually along the time axis before normalising (if enabled), default=False.
+            If True, detrend each time series in the MTS dataset individually along the time axis, default=False.
         normalise (bool, optional):
-            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, default=True.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis, default=True.
     """
     _optional_dependencies = None
 

pyspi/data.py

@@ -38,13 +38,13 @@ class Data:
 
     Args:
         data (array_like, optional):
-            2-dimensional array with raw data, defaults to None.
+            2-dimensional array with raw data, default=None.
         dim_order (str, optional):
-            Order of dimensions, accepts two combinations of the characters 'p', and 's' for processes and observations, defaults to 'ps'.
+            Order of dimensions, accepts two combinations of the characters 'p', and 's' for processes and observations, default='ps'.
         detrend (bool, optional):
-            If True, detrend each time series individually along the time axis before normalising (if enabled), default=False.
+            If True, detrend each time series in the MTS dataset individually along the time axis, default=False.
         normalise (bool, optional):
-            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, default=True.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis, default=True.
         name (str, optional):
             Name of the dataset
         procnames (list, optional):