Release v0.2.0 (#169)

* fix overview rendering issue

* increment version

* update changelog

* fix changelog release date

* remove make clean in netlify toml

* README codecov typo

README.rst

@@ -8,7 +8,7 @@ hyppo
 .. |CircleCI| image:: https://circleci.com/gh/neurodata/hyppo/tree/master.svg?style=shield&circle-token=:circle-token
 .. _CircleCI: https://circleci.com/gh/neurodata/hyppo
 
-.. |Codecov| image:: hhttps://codecov.io/gh/neurodata/hyppo/branch/master/graph/badge.svg?token=a2TXyRVW0a
+.. |Codecov| image:: https://codecov.io/gh/neurodata/hyppo/branch/master/graph/badge.svg?token=a2TXyRVW0a
 .. _Codecov: https://codecov.io/gh/neurodata/hyppo
 
 .. |Netlify| image:: https://img.shields.io/netlify/e5242ebd-631e-4330-b43e-85e428dac66a

docs/news.rst

@@ -5,6 +5,72 @@ Changelog
 
 *Note: People with a "+" by their names contributed a patch for the first time.*
 
+v0.2.0
+------
+| **Release date:** 08 February 2021
+| **Supports:** Python 3.6+.
+
+**New features:**
+
+* Added restricted permutation functionality for Dcorr
+* Kernel functions now wrap scikit-learn and support keyword arguments
+* :class:`hyppo.ksample.Energy`
+* :class:`hyppo.ksample.DISCO`
+* :class:`hyppo.ksample.MMD`
+* Fast 1D exact Dcorr :math:`\mathcal{O}(n \log n)`
+* :class:`hyppo.ksample.Hotelling`
+* :class:`hyppo.ksample.MANOVA`
+* :class:`hyppo.independence.MaxMargin`
+
+**Bug Fixes:**
+
+* Fixed error check for k-sample tests to be between samples instead of within
+* Time series doesn't clip negative values
+* Fix docs not building on netlify
+* Fix p-value calculations for permutation tests to be more in line with literature
+* Fix :class:`hyppo.independence.Dcorr` and :class:`hyppo.independence.Hsic` incorrect stats
+
+**Documentation:**
+
+* Update badges and README to FIRM guidelines
+* Incorrect equation in :meth:`hyppo.tools.circle` docstring
+* Update README to be in line with scikit-learn
+* Remove literature reference section in docstrings, add links to papers
+* Add docstrings for :mod:`hyppo.tools` functions
+* Add ``overview.py`` file for overview of package
+* Add tutorials folder, rewrite so it is more user-friendly (port independence, k-sample, time series)
+* Add examples folder with more information about unique features
+* Move to ``sphinx-gallery`` instead of nbconvert
+* Use ``automodule`` instead of ``autoclass``
+* Make clear about the package requirements and docs requirements
+* Make ``changelog`` into a single file
+* Add external links to neurodata and code of conduct
+* Add citing page to cite the package papers
+* Make index page a clone of README
+* Update MakeFile for more options
+* Add intersphinx mapping with links externally (``numpy``, ``scipy``, etc.) and internally
+* Add docs for statistic function
+* Add discriminability tutorial
+
+**Maintenance:**
+
+* Fix typos in warning commits
+* Updated tests to precalculate distance matrix
+* Moved from Travis CI to Circle CI
+* Raise base ``requirements.txt`` to fix failing tests on CircleCI
+* Add codecoverage config files
+* Add documentation folders and files to ``.gitignore``
+* Remove ``reps`` warning test
+* Cache numba after first call to speed up runs
+* Fix netlify config to new doc build structure
+
+**Authors:**
+
+* Sambit Panda
+* Vivek Gopalakrishnan +
++ Ronak Mehta
+* Ronan Perry +
+
 v0.1.3
 ------
 | **Release date:** 24 July 2020

hyppo/__init__.py

@@ -4,4 +4,4 @@
 import hyppo.time_series
 import hyppo.tools
 
-__version__ = "0.1.3"
+__version__ = "0.2.0"

netlify.toml

@@ -11,7 +11,7 @@
   publish = "docs/_build/html/"
 
   # Default build command.
-  command = "pip install -r docs/requirements.txt; pip install -r requirements.txt; pip install -e .; cd docs; make clean; make all; cd .."
+  command = "pip install -r docs/requirements.txt; pip install -r requirements.txt; pip install -e .; cd docs; make all; cd .."
 
   # Directory with the serverless Lambda functions to deploy to AWS.
   # functions = "project/functions/"

tutorials/overview.py

@@ -19,7 +19,7 @@
 
 Before we get started, here are a few of the conventions we use within hyppo:
 
-* All tests are releagted to a single class, and all classes have a :meth:`test method.
+* All tests are releagted to a single class, and all classes have a :func:`test` method.
   This method returns a test statistic and p-value, as well as other informative
   outputs depending on the test. **We recommend using this method**, though a statistic
   method exists that just returns the test statistic.