Renamed resid methods to resdiuals

nistats/regression.py

@@ -18,6 +18,8 @@
 
 __docformat__ = 'restructuredtext en'
 
+import warnings
+
 import numpy as np
 
 from nibabel.onetime import setattr_on_read
@@ -279,6 +281,15 @@ def __init__(self, theta, Y, model, wY, wresid, cov=None, dispersion=1.,
 
     @setattr_on_read
     def resid(self):
+        warnings.warn(FutureWarning,
+                      "'RegressionResults.resid method has been deprecated "
+                      "and will be removed. "
+                      "Please use RegressionResults.residuals()'.")
+        return self.resdiuals()
+
+
+    @setattr_on_read
+    def residuals(self):
         """
         Residuals from the fit.
         """
@@ -354,6 +365,13 @@ def logL(self, Y):
         raise ValueError('can not use this method for simple results')
 
     def resid(self, Y):
+        warnings.warn(FutureWarning,
+                      "'SimpleRegressionResults.resid method has been deprecated "
+                      "and will be removed. "
+                      "Please use SimpleRegressionResults.residuals()'.")
+        return self.residuals(Y)
+
+    def residuals(self, Y):
         """
         Residuals from the fit.
         """