ENH: Renamed mae_test to significance_test and made the function gene…

…ric (#319)
xarray-contrib · May 17, 2021 · 0851c87 · 0851c87
1 parent 12f3b12
commit 0851c87
Show file tree

Hide file tree

Showing 56 changed files with 300 additions and 300 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,6 +9,11 @@ repos:
       - id: check-merge-conflict
       - id: check-yaml
 
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.8.0
+    hooks:
+      - id: isort
+
   - repo: https://github.com/psf/black
     rev: 21.5b1
     hooks:
@@ -19,11 +24,6 @@ repos:
     hooks:
       - id: flake8
 
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.8.0
-    hooks:
-      - id: isort
-
   - repo: https://github.com/PyCQA/doc8
     rev: 0.9.0a1
     hooks:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -13,6 +13,13 @@ Documentation
 ~~~~~~~~~~~~~
 - Added more info in ``quick-start.ipynb`` (:pr:`316`) `Ray Bell`_.
 
+Breaking changes
+~~~~~~~~~~~~~~~~
+- Renamed `mae_test` to `halfwidth_ci_test` to make this comparative metric
+  generic. Now, it accepts any of the distance metrics functions except for
+  `mape`. The new function has an additional argument called `metric` which is a
+  string and name of the target distance metric. (:pr:`319`) `Taher Chegini`_.
+
 
 xskillscore v0.0.20 (2021-05-08)
 --------------------------------
@@ -266,4 +273,5 @@ Testing
 .. _`mcsitter`: https://github.com/mcsitter
 .. _`Riley X. Brady`: https://github.com/bradyrx
 .. _`Ray Bell`: https://github.com/raybellwaves
+.. _`Taher Chegini`: https://github.com/cheginit
 .. _`Zachary Blackwood`: https://github.com/blackary
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -125,7 +125,7 @@ Tests to compare whether one forecast is significantly better than another one.
 .. autosummary::
     :toctree: api/
 
-    mae_test
+    halfwidth_ci_test
     sign_test
 
 

diff --git a/docs/source/api/xskillscore.Contingency.accuracy.rst b/docs/source/api/xskillscore.Contingency.accuracy.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.accuracy
+xskillscore.Contingency.accuracy
 ================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.bias_score.rst b/docs/source/api/xskillscore.Contingency.bias_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.bias\_score
+xskillscore.Contingency.bias\_score
 ===================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.correct_negatives.rst b/docs/source/api/xskillscore.Contingency.correct_negatives.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.correct\_negatives
+xskillscore.Contingency.correct\_negatives
 ==========================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.equit_threat_score.rst b/docs/source/api/xskillscore.Contingency.equit_threat_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.equit\_threat\_score
+xskillscore.Contingency.equit\_threat\_score
 ============================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst b/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.false\_alarm\_rate
+xskillscore.Contingency.false\_alarm\_rate
 ==========================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst b/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.false\_alarm\_ratio
+xskillscore.Contingency.false\_alarm\_ratio
 ===========================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.false_alarms.rst b/docs/source/api/xskillscore.Contingency.false_alarms.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.false\_alarms
+xskillscore.Contingency.false\_alarms
 =====================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.gerrity_score.rst b/docs/source/api/xskillscore.Contingency.gerrity_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.gerrity\_score
+xskillscore.Contingency.gerrity\_score
 ======================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.heidke_score.rst b/docs/source/api/xskillscore.Contingency.heidke_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.heidke\_score
+xskillscore.Contingency.heidke\_score
 =====================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.hit_rate.rst b/docs/source/api/xskillscore.Contingency.hit_rate.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.hit\_rate
+xskillscore.Contingency.hit\_rate
 =================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.hits.rst b/docs/source/api/xskillscore.Contingency.hits.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.hits
+xskillscore.Contingency.hits
 ============================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.misses.rst b/docs/source/api/xskillscore.Contingency.misses.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.misses
+xskillscore.Contingency.misses
 ==============================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio.rst b/docs/source/api/xskillscore.Contingency.odds_ratio.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.odds\_ratio
+xskillscore.Contingency.odds\_ratio
 ===================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst b/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.odds\_ratio\_skill\_score
+xskillscore.Contingency.odds\_ratio\_skill\_score
 =================================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.peirce_score.rst b/docs/source/api/xskillscore.Contingency.peirce_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.peirce\_score
+xskillscore.Contingency.peirce\_score
 =====================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.rst b/docs/source/api/xskillscore.Contingency.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency
+xskillscore.Contingency
 =======================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.success_ratio.rst b/docs/source/api/xskillscore.Contingency.success_ratio.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.success\_ratio
+xskillscore.Contingency.success\_ratio
 ======================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.table.rst b/docs/source/api/xskillscore.Contingency.table.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.table
+xskillscore.Contingency.table
 =============================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.Contingency.threat_score.rst b/docs/source/api/xskillscore.Contingency.threat_score.rst
@@ -1,4 +1,4 @@
-xskillscore.Contingency.threat\_score
+xskillscore.Contingency.threat\_score
 =====================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.brier_score.rst b/docs/source/api/xskillscore.brier_score.rst
@@ -1,4 +1,4 @@
-xskillscore.brier\_score
+xskillscore.brier\_score
 ========================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.crps_ensemble.rst b/docs/source/api/xskillscore.crps_ensemble.rst
@@ -1,4 +1,4 @@
-xskillscore.crps\_ensemble
+xskillscore.crps\_ensemble
 ==========================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.crps_gaussian.rst b/docs/source/api/xskillscore.crps_gaussian.rst
@@ -1,4 +1,4 @@
-xskillscore.crps\_gaussian
+xskillscore.crps\_gaussian
 ==========================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.crps_quadrature.rst b/docs/source/api/xskillscore.crps_quadrature.rst
@@ -1,4 +1,4 @@
-xskillscore.crps\_quadrature
+xskillscore.crps\_quadrature
 ============================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.discrimination.rst b/docs/source/api/xskillscore.discrimination.rst
@@ -1,4 +1,4 @@
-xskillscore.discrimination
+xskillscore.discrimination
 ==========================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.effective_sample_size.rst b/docs/source/api/xskillscore.effective_sample_size.rst
@@ -1,4 +1,4 @@
-xskillscore.effective\_sample\_size
+xskillscore.effective\_sample\_size
 ===================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.halfwidth_ci_test.rst b/docs/source/api/xskillscore.halfwidth_ci_test.rst
@@ -0,0 +1,6 @@
+xskillscore.halfwidth\_ci\_test
+===============================
+
+.. currentmodule:: xskillscore
+
+.. autofunction:: halfwidth_ci_test
diff --git a/docs/source/api/xskillscore.mae.rst b/docs/source/api/xskillscore.mae.rst
@@ -1,4 +1,4 @@
-xskillscore.mae
+xskillscore.mae
 ===============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.mae_test.rst b/docs/source/api/xskillscore.mae_test.rst
diff --git a/docs/source/api/xskillscore.mape.rst b/docs/source/api/xskillscore.mape.rst
@@ -1,4 +1,4 @@
-xskillscore.mape
+xskillscore.mape
 ================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.me.rst b/docs/source/api/xskillscore.me.rst
@@ -1,4 +1,4 @@
-xskillscore.me
+xskillscore.me
 ==============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.median_absolute_error.rst b/docs/source/api/xskillscore.median_absolute_error.rst
@@ -1,4 +1,4 @@
-xskillscore.median\_absolute\_error
+xskillscore.median\_absolute\_error
 ===================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.mse.rst b/docs/source/api/xskillscore.mse.rst
@@ -1,4 +1,4 @@
-xskillscore.mse
+xskillscore.mse
 ===============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.pearson_r.rst b/docs/source/api/xskillscore.pearson_r.rst
@@ -1,4 +1,4 @@
-xskillscore.pearson\_r
+xskillscore.pearson\_r
 ======================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.pearson_r_eff_p_value.rst b/docs/source/api/xskillscore.pearson_r_eff_p_value.rst
@@ -1,4 +1,4 @@
-xskillscore.pearson\_r\_eff\_p\_value
+xskillscore.pearson\_r\_eff\_p\_value
 =====================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.pearson_r_p_value.rst b/docs/source/api/xskillscore.pearson_r_p_value.rst
@@ -1,4 +1,4 @@
-xskillscore.pearson\_r\_p\_value
+xskillscore.pearson\_r\_p\_value
 ================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.r2.rst b/docs/source/api/xskillscore.r2.rst
@@ -1,4 +1,4 @@
-xskillscore.r2
+xskillscore.r2
 ==============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.rank_histogram.rst b/docs/source/api/xskillscore.rank_histogram.rst
@@ -1,4 +1,4 @@
-xskillscore.rank\_histogram
+xskillscore.rank\_histogram
 ===========================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.reliability.rst b/docs/source/api/xskillscore.reliability.rst
@@ -1,4 +1,4 @@
-xskillscore.reliability
+xskillscore.reliability
 =======================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.rmse.rst b/docs/source/api/xskillscore.rmse.rst
@@ -1,4 +1,4 @@
-xskillscore.rmse
+xskillscore.rmse
 ================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.roc.rst b/docs/source/api/xskillscore.roc.rst
@@ -1,4 +1,4 @@
-xskillscore.roc
+xskillscore.roc
 ===============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.rps.rst b/docs/source/api/xskillscore.rps.rst
@@ -1,4 +1,4 @@
-xskillscore.rps
+xskillscore.rps
 ===============
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.sign_test.rst b/docs/source/api/xskillscore.sign_test.rst
@@ -1,4 +1,4 @@
-xskillscore.sign\_test
+xskillscore.sign\_test
 ======================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.smape.rst b/docs/source/api/xskillscore.smape.rst
@@ -1,4 +1,4 @@
-xskillscore.smape
+xskillscore.smape
 =================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.spearman_r.rst b/docs/source/api/xskillscore.spearman_r.rst
@@ -1,4 +1,4 @@
-xskillscore.spearman\_r
+xskillscore.spearman\_r
 =======================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.spearman_r_eff_p_value.rst b/docs/source/api/xskillscore.spearman_r_eff_p_value.rst
@@ -1,4 +1,4 @@
-xskillscore.spearman\_r\_eff\_p\_value
+xskillscore.spearman\_r\_eff\_p\_value
 ======================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.spearman_r_p_value.rst b/docs/source/api/xskillscore.spearman_r_p_value.rst
@@ -1,4 +1,4 @@
-xskillscore.spearman\_r\_p\_value
+xskillscore.spearman\_r\_p\_value
 =================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/api/xskillscore.threshold_brier_score.rst b/docs/source/api/xskillscore.threshold_brier_score.rst
@@ -1,4 +1,4 @@
-xskillscore.threshold\_brier\_score
+xskillscore.threshold\_brier\_score
 ===================================
 
 .. currentmodule:: xskillscore

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,6 +32,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autodoc.typehints",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.extlinks",
@@ -48,6 +49,8 @@
     "pr": ("https://github.com/xarray-contrib/xskillscore/pull/%s", "GH#"),
 }
 
+autodoc_typehints = "description"
+
 nbsphinx_timeout = 60
 nbsphinx_execute = "always"