Metadata-Version: 2.1
Name: xicor
Version: 1.0.1
Summary: xi correlation for tied data
Home-page: https://github.com/czbiohub/xicor/
Author: Phoenix Logan
Author-email: phoenix.logan@czbiohub.org
Maintainer: Pranathi Vemuri
Maintainer-email: pranathi93.vemuri@gmail.com
License: MIT
Description: xicor
        ================================
        ![Tests](https://travis-ci.com/czbiohub/xicor.svg)
        [![codecov](https://codecov.io/gh/czbiohub/xicor/branch/master/graph/badge.svg)](https://codecov.io/gh/czbiohub/xicor)
        
        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](https://arxiv.org/abs/1909.10140). It is based off the R code mentioned in the paper: https://statweb.stanford.edu/~souravc/xi.R 
        
        -   Free software: MIT license
        -   Documentation: https://czbiohub.github.io/xicor
        
        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)
        
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: test
