Skip to content

Commit e1e8ea9

Browse files
committed
Updated readme
1 parent a324550 commit e1e8ea9

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,39 @@ A simple library to calculate correlation between variables. Currently provides
44
Based on statistical methodology like Cramer'V and Tschuprow'T allows to gauge the correlation between categorical variables. Ability to plot the correlation in form of heatmap is also provided.
55

66
## Usage example
7+
```
8+
import pandas as pd
9+
from pycorrcat.pycorrcat import plot_corr, corr_matrix
710
11+
df = pd.DataFrame([('a', 'b'), ('a', 'd'), ('c', 'b'), ('e', 'd')],
12+
columns=['dogs', 'cats'])
13+
14+
correlation_matrix = corr_matrix(data, ['dogs', 'cats'])
15+
plot_corr(df, ['dogs','cats'] )
16+
```
817

918
## Development setup
19+
Create a virtualenv and install dependencies from ```requirements.txt``` and continue with code change.
1020

1121
## Release History
1222

23+
* 0.1.4
24+
* CHANGE: Changed the documentation (no code change)
1325
* 0.1.3
14-
* CHANGE: Remove `setDefaultXYZ()`
1526
* ADD: Ability to pass dataframe to get correlation matrix
1627
* ADD: Ability to plot the correlation in form of heatmap
1728
* 0.1.2
1829
* Added as first release
1930
* 0.1.1
2031
* Test release
2132

22-
## Meta
33+
## Author and Contributor
2334

24-
Anurag Kumar Mishra – [https://github.com/anuragithub](https://github.com/anuragithub) [email protected]
35+
Anurag Kumar Mishra – Connect on [github](https://github.com/anuragithub) or drop a [mail](mailto:[email protected])
2536

2637
Distributed under the GNU license. See ``LICENSE`` for more information.
2738

28-
[https://github.com/MavericksDS/pycorr](https://github.com/MavericksDS/pycorr)
39+
Github repo link [https://github.com/MavericksDS/pycorr](https://github.com/MavericksDS/pycorr)
2940

3041

3142
## Contributing

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setup(
1212
name='pycorr',
13-
version='0.1.3',
13+
version='0.1.4',
1414
description='Python package for calculating correlation amongst categorical variables',
1515
long_description_content_type='text/markdown',
1616
long_description=long_description,

0 commit comments

Comments
 (0)