Skip to main content

dcor: distance correlation and energy statistics in Python.

Project description

dcor
====

|tests| |docs| |coverage| |pypi| |conda| |zenodo|

dcor: distance correlation and energy statistics in Python.

E-statistics are functions of distances between statistical observations
in metric spaces.

Distance covariance and distance correlation are
dependency measures between random vectors introduced in [SRB07]_ with
a simple E-statistic estimator.

This package offers functions for calculating several E-statistics
such as:

- Estimator of the energy distance [SR13]_.
- Biased and unbiased estimators of distance covariance and
distance correlation [SRB07]_.
- Estimators of the partial distance covariance and partial
distance covariance [SR14]_.

It also provides tests based on these E-statistics:

- Test of homogeneity based on the energy distance.
- Test of independence based on distance covariance.

Installation
============

dcor is on PyPi and can be installed using :code:`pip`:

.. code::

pip install dcor

It is also available for :code:`conda` using the :code:`conda-forge` channel:

.. code::

conda install -c conda-forge dcor

Previous versions of the package were in the :code:`vnmabus` channel. This
channel will not be updated with new releases, and users are recommended to
use the :code:`conda-forge` channel.

Requirements
------------

dcor is available in Python 3.8 or above in all operating systems.
The package dcor depends on the following libraries:

- numpy
- numba >= 0.51
- scipy
- joblib

Documentation
=============
The documentation can be found in https://dcor.readthedocs.io/en/latest/?badge=latest

References
==========

.. [SR13] Gábor J. Székely and Maria L. Rizzo. Energy statistics: a class of
statistics based on distances. Journal of Statistical Planning and
Inference, 143(8):1249 – 1272, 2013.
URL:
http://www.sciencedirect.com/science/article/pii/S0378375813000633,
doi:10.1016/j.jspi.2013.03.018.
.. [SR14] Gábor J. Székely and Maria L. Rizzo. Partial distance correlation
with methods for dissimilarities. The Annals of Statistics,
42(6):2382–2412, 12 2014.
doi:10.1214/14-AOS1255.
.. [SRB07] Gábor J. Székely, Maria L. Rizzo, and Nail K. Bakirov. Measuring and
testing dependence by correlation of distances. The Annals of
Statistics, 35(6):2769–2794, 12 2007.
doi:10.1214/009053607000000505.

.. |tests| image:: https://github.com/vnmabus/dcor/actions/workflows/main.yml/badge.svg
:alt: Tests
:scale: 100%
:target: https://github.com/vnmabus/dcor/actions/workflows/main.yml

.. |docs| image:: https://readthedocs.org/projects/dcor/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://dcor.readthedocs.io/en/latest/?badge=latest

.. |coverage| image:: http://codecov.io/github/vnmabus/dcor/coverage.svg?branch=develop
:alt: Coverage Status
:scale: 100%
:target: https://codecov.io/gh/vnmabus/dcor/branch/develop

.. |pypi| image:: https://badge.fury.io/py/dcor.svg
:alt: Pypi version
:scale: 100%
:target: https://pypi.python.org/pypi/dcor/

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/dcor
:alt: Available in Conda
:scale: 100%
:target: https://anaconda.org/conda-forge/dcor

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3468124.svg
:alt: Zenodo DOI
:scale: 100%
:target: https://doi.org/10.5281/zenodo.3468124

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dcor-0.6.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

dcor-0.6-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

Details for the file dcor-0.6.tar.gz.

File metadata

  • Download URL: dcor-0.6.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for dcor-0.6.tar.gz
Algorithm Hash digest
SHA256 f5d39776101db4787348e6be6cd9369341efeb40b070509a30d5c57185558431
MD5 37b48e0a3f7208f7c8d6b2b70adb2468
BLAKE2b-256 00a71d06e98f1b123be60ba5de004edba510025da689c8cfb501299a8f2ba1d1

See more details on using hashes here.

File details

Details for the file dcor-0.6-py3-none-any.whl.

File metadata

  • Download URL: dcor-0.6-py3-none-any.whl
  • Upload date:
  • Size: 55.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for dcor-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 de306fc666668188749730fc803fc1d4d804d9886c92b622ba57b434fed395a2
MD5 018dbc15bb4bc92bcbcef4d6daeedf8d
BLAKE2b-256 45f349770c523067d2179a600f236ea6d55f0a02909a424d055dbc50e04c4860

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page