validator for the fit CI estimator

Author: phobson

probscale/tests/test_validate.py

@@ -3,6 +3,8 @@
 import pytest
 
 from probscale import validate
+from probscale import algo
+
 
 
 def test_axes_object_invalid():
@@ -86,3 +88,17 @@ def test_other_options(value, expected):
 def test_axis_label(value, expected):
     result = validate.axis_label(value)
     assert result == expected
+
+
+@pytest.mark.parametrize(('value', 'expected'), [
+    ('fit', algo._bs_fit),
+    ('resids', algo._bs_resid),
+    ('junk', None)
+])
+def test_estimator(value, expected):
+    if expected is None:
+        with pytest.raises(ValueError):
+            validate.estimator(value)
+    else:
+        est = validate.estimator(value)
+        assert est is expected

probscale/validate.py

@@ -82,4 +82,15 @@ def other_options(options):
     Replaces None with an empty dict for plotting options.
     """
 
-    return dict() if options is None else options.copy()
+    return dict() if options is None else options.copy()
+
+def estimator(value):
+    from .algo import _bs_fit, _bs_resid
+    if value.lower() in ['res', 'resid', 'resids', 'residual', 'residuals']:
+        est = _bs_resid
+    elif value.lower() in ['fit', 'values']:
+        est = _bs_fit
+    else:
+        raise ValueError('estimator must be either "resid" or "fit".')
+
+    return est