adding helper function for printing and asserting outcome of each test

docs/api.rst

@@ -16,3 +16,10 @@ CategoricalEvaluator
   :members:
   :inherited-members:
   :show-inheritance:
+
+  Utilities
+  ---------
+  .. automodule:: predeval.utilities
+    :members:
+    :inherited-members:
+    :show-inheritance:

docs/source/predeval.rst

@@ -28,6 +28,14 @@ predeval.parent module
     :inherited-members:
     :show-inheritance:
 
+predeval.utilities module
+----------------------
+
+.. automodule:: predeval.utilities
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
 
 Module contents
 ---------------

predeval/__init__.py

@@ -8,5 +8,8 @@
 
 from .continuous import ContinuousEvaluator
 from .categorical import CategoricalEvaluator
+from .utilities import evaluate_tests
 
-__all__ = ['ContinuousEvaluator', 'CategoricalEvaluator']
+__all__ = ['ContinuousEvaluator',
+           'CategoricalEvaluator',
+           'evaluate_tests']

predeval/parent.py

@@ -9,6 +9,23 @@
 class ParentPredEval(object):
     """
     Parent Class for evaluator classes.
+
+    ...
+
+    Parameters
+    ----------
+    ref_data : list of int or float or np.array
+        This the reference data for all tests. All future data will be compared to this data.
+    verbose : bool, optional
+        Whether tests should print their output. Default is true
+
+    Attributes
+    ----------
+    verbose : bool
+        Whether or not tests will print output.
+    ref_data : : list of int or float or np.array
+        This the reference data for all tests. All future data will be compared to this data.
+
     """
     __metaclass__ = ABCMeta
 

predeval/utilities.py

@@ -0,0 +1,34 @@
+"""Library of classes for evaluating continuous model outputs."""
+
+__author__ = 'Dan Vatterott'
+__license__ = 'MIT'
+
+
+def evaluate_tests(test_ouputs, assert_test=False, verbose=True):
+    """Check whether the data passed evaluation tests.
+
+    Parameters
+    ----------
+    test_ouputs : list of tuples
+        Each tuple has a string a boolean. The string describes the test.
+        The boolean describes the outcome. True is a pass and False is a fail.
+        This is the output of the check_data method.
+    assert_test : bool
+        Whether to assert the test passed. Default is False.
+    verbose : bool
+        Whether to print whether each test was passed or not.
+
+    Returns
+    -------
+    None
+
+    """
+    for test_name, test_val in test_ouputs:
+        if test_val:
+            if verbose:
+                print('Passed {} test.'.format(test_name))
+        else:
+            if verbose:
+                print('Failed {} test.'.format(test_name))
+            if assert_test:
+                assert test_val, 'Error. Failed {} test.'