cleaned up docstrings

removed references to unused functions

Author: CommonClimate

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/utils/correlation.py

@@ -130,7 +130,6 @@ def fdr(pvals, qlevel=0.05, method='original', adj_method=None, adj_args={}):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     
 
     References
@@ -206,9 +205,6 @@ def corr_ttest(y1, y2, alpha=0.05, df_min=10):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
-    pyleoclim.utils.correlation.corr_isopersist : Estimate Pearson's correlation and associated significance using AR(1)
-    pyleoclim.utils.correlation.corr_isospec : Estimate Pearson's correlation and associated significance using phase randomization
     pyleoclim.utils.correlation.fdr : Determine significance based on the false discovery rate
 
     """
@@ -409,7 +405,6 @@ def fdr_basic(pvals,qlevel=0.05):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdf : Determine significance based on the false discovery rate
 
     References
@@ -459,7 +454,6 @@ def fdr_master(pvals, qlevel=0.05, method='original'):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdf : Determine significance based on the false discovery rate
 
     References
@@ -496,7 +490,6 @@ def storey(edf_quantile, pvals):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdf : Determine significance based on the false discovery rate
 
     References
@@ -545,7 +538,6 @@ def prop_alt(pvals, adj_method='mean', adj_args={'edf_lower': 0.8, 'num_steps':
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdf : Determine significance based on the false discovery rate
 
     References

pyleoclim/utils/tsmodel.py

@@ -298,7 +298,6 @@ def isopersistent_rn(y, p):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdr : Determine significance based on the false discovery rate
 
     Notes
@@ -340,7 +339,6 @@ def sm_ar1_sim(n, p, g, sig):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdr : Determine significance based on the false discovery rate
 
     '''

pyleoclim/utils/tsutils.py

@@ -1934,7 +1934,6 @@ def make_even_axis(x=None,start=None,stop=None,step=None,step_style=None,no_nans
 #     See also
 #     --------
 # 
-#     pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
 #     pyleoclim.utils.correlation.fdr : Determine significance based on the false discovery rate
 # 
 #     References
@@ -2001,7 +2000,6 @@ def phaseran(y, nsurr):
     See also
     --------
 
-    pyleoclim.utils.correlation.corr_sig : Estimates the Pearson's correlation and associated significance between two non IID time series
     pyleoclim.utils.correlation.fdr : Determine significance based on the false discovery rate
 
     References