Prune utils

pyleoclim/core/corr.py

@@ -62,9 +62,8 @@ class Corr:
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Correlation function
-
     pyleoclim.utils.correlation.fdr : FDR function
+    pyleoclim.utils.correlation.association : workhorse function to compute various metrics of association
     '''
 
     def __init__(self, r, p, r_crit, signif, alpha, p_fmt_td=0.01, p_fmt_style='exp'):

pyleoclim/core/correns.py

@@ -80,9 +80,8 @@ class CorrEns:
 
     See also
     --------
-
-    pyleoclim.utils.correlation.corr_sig : Correlation function
 
+    pyleoclim.utils.correlation.association : workhorse function to compute various metrics of association
     pyleoclim.utils.correlation.fdr : FDR (False Discovery Rate) function
     '''
 

pyleoclim/core/series.py

@@ -3936,8 +3936,6 @@ def correlation(self, target_series, alpha=0.05, statistic='pearsonr', method =
         See also
         --------
 
-        pyleoclim.utils.correlation.corr_sig : Correlation function (marked for deprecation)
-
         pyleoclim.utils.correlation.association : SciPy measures of association between variables
 
         pyleoclim.series.surrogates : parametric and non-parametric surrogates of any Series object
@@ -4206,7 +4204,7 @@ def causality(self, target_series, method='liang', timespan=None, settings=None,
 
     #     pyleoclim.utils.tsmodel.ar1_sim : AR(1) simulator
     #     pyleoclim.utils.tsmodel.uar1_sim : maximum likelihood AR(1) simulator
-    #     pyleoclim.utils.tsutils.phaseran2 : phase randomization
+    #     pyleoclim.utils.tsutils.phaseran : phase randomization
     #     pyleoclim.utils.tsutils.random_time_axis : random time index vector according to a specific probability model
 
     #     '''
@@ -4248,7 +4246,7 @@ def causality(self, target_series, method='liang', timespan=None, settings=None,
 
     #     elif method == 'phaseran':
     #         if self.is_evenly_spaced() and time_pattern != "random":
-    #             y_surr = tsutils.phaseran2(self.value, number)
+    #             y_surr = tsutils.phaseran(self.value, number)
     #         else:
     #             raise ValueError("Phase-randomization presently requires evenly-spaced series.")
 

pyleoclim/core/surrogateseries.py

@@ -110,7 +110,7 @@ def from_series(self, target_series):
 
         pyleoclim.utils.tsmodel.uar1_sim : maximum likelihood AR(1) simulator
 
-        pyleoclim.utils.tsutils.phaseran2 : phase randomization
+        pyleoclim.utils.tsutils.phaseran : phase randomization
 
         Examples
         --------
@@ -140,7 +140,7 @@ def from_series(self, target_series):
 
         elif self.method == 'phaseran':
             if target_series.is_evenly_spaced():
-                y_surr = tsutils.phaseran2(target_series.value, self.number)
+                y_surr = tsutils.phaseran(target_series.value, self.number)
             else:
                 raise ValueError("Phase-randomization presently requires evenly-spaced series.")