Skip to content

Commit 9676408

Browse files
authored
Update README.md
1 parent b606e90 commit 9676408

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

README.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,40 @@
66
[![Downloads](https://pepy.tech/badge/df2onehot/month)](https://pepy.tech/project/df2onehot/month)
77
[![Downloads](https://pepy.tech/badge/df2onehot)](https://pepy.tech/project/df2onehot)
88
[![DOI](https://zenodo.org/badge/245003302.svg)](https://zenodo.org/badge/latestdoi/245003302)
9+
[![Sphinx](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/df2onehot/)
910
<!---[![BuyMeCoffee](https://img.shields.io/badge/buymea-coffee-yellow.svg)](https://www.buymeacoffee.com/erdogant)-->
1011
<!---[![Coffee](https://img.shields.io/badge/coffee-black-grey.svg)](https://erdogant.github.io/donate/?currency=USD&amount=5)-->
1112

1213
``df2onehot`` is a Python package to convert unstructured DataFrames into structured dataframes, such as one-hot dense arrays.
1314

1415
#
15-
**Star this repo if you like it! ⭐️**
16+
**⭐️ Star this repo if you like it ⭐️**
1617
#
1718

18-
### Installation
19+
#### Install df2onehot from PyPI
1920

20-
```
21+
```bash
2122
pip install df2onehot
2223
```
2324

24-
* Alternatively, install df2onehot from the GitHub source:
25-
```bash
26-
git clone https://github.com/erdogant/df2onehot.git
27-
cd df2onehot
28-
python -U setup.py install
29-
```
30-
3125
#### Import df2onehot package
26+
3227
```python
33-
import df2onehot
34-
# Example dataset
35-
df = df2onehot.import_example()
28+
from df2onehot import df2onehot
3629
```
30+
#
31+
32+
33+
### [Documentation pages](https://erdogant.github.io/df2onehot/)
3734

38-
#### Example:
35+
On the [documentation pages](https://erdogant.github.io/df2onehot/) you can find detailed information about the working of the ``df2onehot`` with many examples.
36+
37+
<hr>
38+
39+
### Examples
3940

4041
```python
41-
from df2onehot import df2onehot
42-
# Convert
43-
out = df2onehot(df)
42+
results = df2onehot(df)
4443
```
4544

4645
```python
@@ -59,6 +58,16 @@ out = df2onehot(df, y_min=2, perc_min_num=0.8)
5958
```
6059

6160

61+
#
62+
* [Example: Process Mixed dataset](https://erdogant.github.io/df2onehot/pages/html/Examples.html#)
63+
#
64+
* [Example: Extracting nested columns](https://erdogant.github.io/df2onehot/pages/html/Examples.html#extracting-nested-columns)
65+
#
66+
* [Example: Setting custom dtypes](https://erdogant.github.io/df2onehot/pages/html/Examples.html#custom-dtypes)
67+
#
68+
69+
<hr>
70+
6271
#### Maintainers
6372
* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
6473
* Contributions are welcome.

0 commit comments

Comments
 (0)