Skip to content

Commit 744dab1

Browse files
committed
use only 1 md file
1 parent 968db10 commit 744dab1

File tree

5 files changed

+22
-59
lines changed

5 files changed

+22
-59
lines changed

INFO.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
include requirements.txt README.md INFO.md
1+
include requirements.txt README.md
22
prune tests*

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# PyPair
44

5-
PyPair is a statistical library to compute pairwise association between any two variables.
5+
PyPair is a statistical library to compute pairwise association between any two variables. In general, statistical variable types are viewed as `categorical` or `continuous`. Categorical variables have no inherit order to their values, while continuous variables do. This API has `over 130 association measures` implemented for any combination of categorical and/or continuous variables.
66

77
- [Documentation](https://py-pair.readthedocs.io/)
88
- [PyPi](https://pypi.org/project/pypair/)
@@ -26,6 +26,23 @@ print('-' * 15)
2626
print(tanimoto_corr)
2727
```
2828

29+
Another way to get started with PyPair is to use the `convenience` methods whose names indicate the variable pair types.
30+
31+
```python
32+
from pypair.association import binary_binary, categorical_categorical, \
33+
binary_continuous, concordance, categorical_continuous, continuous_continuous, confusion, agreement
34+
35+
# assume a and b are the appropriate iterables of values for 2 variables
36+
jaccard = binary_binary(a, b, measure='jaccard')
37+
acc = confusion(a, b, measure='acc')
38+
phi = categorical_categorical(a, b, measure='phi')
39+
kappa = agreement(a, b, measure='cohen_k')
40+
biserial = binary_continuous(a, b, measure='biserial')
41+
tau = concordance(a, b, measure='kendall_tau')
42+
eta = categorical_continuous(a, b, measure='eta')
43+
pearson = continuous_continuous(a, b, measure='pearson')
44+
```
45+
2946
# Software Copyright
3047

3148
```

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
author = 'Jee Vang'
2323

2424
# The full version, including alpha/beta/rc tags
25-
release = '3.0.6'
25+
release = '3.0.7'
2626

2727

2828
# -- General configuration ---------------------------------------------------

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
from setuptools import setup, find_packages
22

3-
with open('INFO.md', 'r') as fh:
3+
with open('README.md', 'r') as fh:
44
long_desc = fh.read()
55

66
setup(
77
name='pypair',
8-
version='3.0.6',
8+
version='3.0.7',
99
author='Jee Vang',
1010
author_email='vangjee@gmail.com',
1111
packages=find_packages(exclude=('*.tests', '*.tests.*', 'tests.*', 'tests')),

0 commit comments

Comments
 (0)