magomar / xicor

xi correlation method adapted for python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

xicor

Tests codecov

xi correlation method adapted for python

What is xicor?

xicor is an implementation of the "xi" correlation metric described in Chatterjee, S. (2019, September 22). A new coefficient of correlation. arxiv.org/abs/1909.10140. It is based off the R code mentioned in the paper: https://statweb.stanford.edu/~souravc/xi.R

Installation

The package can be installed from PyPI using pip here:

pip install xicor

Developmental install

To install this code and play around with the code locally, clone this github repository and use pip to install:

git clone https://github.com/czbiohub/xicor.git
cd xicor

# The "." means "install *this*, the folder where I am now"
pip install .
# or you could install using
python setup.py install

Usage

from xicor.xicor import Xi
xi_obj = Xi([1, 2, 3], [1, 2, 3])
correlation = xi_obj.correlation
pvals = xi_obj.pval_asymptotic(ties=False, nperm=1000)

About

xi correlation method adapted for python

License:MIT License


Languages

Language:Jupyter Notebook 61.0%Language:Python 36.9%Language:TeX 1.3%Language:Makefile 0.8%