Type i error checks (#178)

* add benchmarks folder to gitignore * sum used to prevent deprecation warning * fix fast 1D dcorr invalid implementation * add power unit tests * add base classes to documentation * fix doctest assertion errors * rename codecov so yml shows up * fix pytest assertions
neurodata · Feb 25, 2021 · f286984 · f286984
1 parent cf0ebed
commit f286984
Show file tree

Hide file tree

Showing 63 changed files with 654 additions and 2,272 deletions.
diff --git a/.gitignore b/.gitignore
@@ -94,6 +94,7 @@ docs/_build
 docs/gallery
 docs/tutorials
 docs/sample_data
+docs/benchmarks
 
 # Spyder project settings
 .spyderproject

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -120,6 +120,8 @@ We recommended that your contribution complies with the following rules before y
   pip install pytest pytest-cov
   pytest
   ```
+- If you are proposing adding a new module, make sure you are inheriting from the appropriate base class. See
+  [the documentation](https://hyppo.neurodata.io/api/index.html#base-classes) for the appropriate class.
 
 # Guidelines
 

diff --git a/.codecov.yml → codecov.yml b/.codecov.yml → codecov.yml
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -148,3 +148,16 @@ Miscellaneous
    tools.perm_test
    tools.chi2_approx
    tools.power
+
+
+
+Base Classes
+-------------
+
+.. autosummary::
+   :toctree: generated/
+
+   independence.base.IndependenceTest
+   ksample.base.KSampleTest
+   time_series.base.TimeSeriesTest
+   discrim.base.DiscriminabilityTest
diff --git a/docs/benchmarks/images/sphx_glr_indep_power_dimension_001.png b/docs/benchmarks/images/sphx_glr_indep_power_dimension_001.png
diff --git a/docs/benchmarks/images/sphx_glr_indep_power_sampsize_001.png b/docs/benchmarks/images/sphx_glr_indep_power_sampsize_001.png
diff --git a/docs/benchmarks/images/sphx_glr_perf_1d_001.png b/docs/benchmarks/images/sphx_glr_perf_1d_001.png
diff --git a/docs/benchmarks/images/sphx_glr_same_stat_001.png b/docs/benchmarks/images/sphx_glr_same_stat_001.png
diff --git a/docs/benchmarks/images/thumb/sphx_glr_indep_power_dimension_thumb.png b/docs/benchmarks/images/thumb/sphx_glr_indep_power_dimension_thumb.png
diff --git a/docs/benchmarks/images/thumb/sphx_glr_indep_power_sampsize_thumb.png b/docs/benchmarks/images/thumb/sphx_glr_indep_power_sampsize_thumb.png
diff --git a/docs/benchmarks/images/thumb/sphx_glr_perf_1d_thumb.png b/docs/benchmarks/images/thumb/sphx_glr_perf_1d_thumb.png
diff --git a/docs/benchmarks/images/thumb/sphx_glr_same_stat_thumb.png b/docs/benchmarks/images/thumb/sphx_glr_same_stat_thumb.png
diff --git a/docs/benchmarks/indep_power_dimension.ipynb b/docs/benchmarks/indep_power_dimension.ipynb
diff --git a/docs/benchmarks/indep_power_dimension.py b/docs/benchmarks/indep_power_dimension.py
diff --git a/docs/benchmarks/indep_power_dimension.py.md5 b/docs/benchmarks/indep_power_dimension.py.md5