Skip to main content

xicorrelation

Project description

GitHub Actions status for master branch https://codecov.io/gh/jettify/xicorrelation/branch/master/graph/badge.svg https://img.shields.io/pypi/pyversions/xicorrelation.svg https://img.shields.io/pypi/v/xicorrelation.svg Documentation Status

xicorrelation package implements xi correlation formula proposed in https://arxiv.org/pdf/1909.10140.pdf.

It is based off the R code mentioned in the paper: https://statweb.stanford.edu/~souravc/xi.R and R package https://github.com/cran/XICOR

https://raw.githubusercontent.com/jettify/xicorrelation/master/docs/anscombe.png

Simple example

from xicorrelation import xicorr

x = [10, 8, 13, 9, 11, 14, 6, 4, 12, 7, 5]
y = [8.04, 6.95, 7.58, 8.81, 8.33, 9.96, 7.24, 4.26, 10.84, 4.82, 5.68]

# API similar to spearmanr or kendalltau from scipy
xi, pvalue = xicorr(x, y)
print("xi", xi)
print("pvalue", pvalue)

Installation

Installation process is simple, just:

$ pip install xicorrelation

Changes

0.3.0

  • Rework API do be similar to scipy.

0.2.1

  • Initial release.

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

xicorrelation-0.3.0.tar.gz (58.8 kB view hashes)

Uploaded Source

Built Distribution

xicorrelation-0.3.0-py3-none-any.whl (8.6 kB view hashes)

Uploaded Python 3

Supported by

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