Skip to content

Commit c1314b7

Browse files
authored
Refine README formatting and content
Updated headings and descriptions for clarity and consistency.
1 parent 21b0ee8 commit c1314b7

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# % Percentify %
1+
# Percentify
22
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/percentify?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/percentify)
33
[![PyPI version](https://img.shields.io/pypi/v/percentify.svg?style=flat&color=blue)](https://pypi.org/project/percentify/)
44
[![Python Versions](https://img.shields.io/pypi/pyversions/percentify.svg?style=flat&color=green)](https://pypi.org/project/percentify/)
55
[![License](https://img.shields.io/pypi/l/percentify.svg?style=flat&color=orange)](LICENSE)
66
[![Build Status](https://github.com/data-centt/percentify/actions/workflows/python-app.yml/badge.svg)](https://github.com/data-centt/percentify/actions/workflows/python-app.yml)
77

8-
**Percentify** one import, one line, the stats you actually need.
8+
**Percentify** is a one import, one line code, that covers all stats you need for your data analysis and codebase.
99

1010
Stop digging through scipy, statsmodels, and sklearn for operations you run every day. Percentify surfaces the most common percentage and statistical calculations into simple, readable function calls.
1111

12-
**Beyond percentages** — percentify gives you easy access to deeply buried, everyday-useful statistical operations in just one import.
12+
1313

1414
---
1515

@@ -20,9 +20,9 @@ pip install percentify
2020

2121
---
2222

23-
## ✨ Core Percentage Toolkit
23+
## ✨ Core Percentage Toolkit
2424

25-
### `percent` Part of a Whole
25+
### `percent`: Part of a Whole
2626
```python
2727
from percentify import percent
2828

@@ -31,31 +31,31 @@ percent(1, 3) # → 33.33
3131
percent(5, 0) # → 0.0 (safe division by zero)
3232
```
3333

34-
### `change` Percentage Increase or Decrease
34+
### `change`: Percentage Increase or Decrease
3535
```python
3636
from percentify import change
3737

3838
change(100, 150) # → 50.0 (50% increase)
3939
change(200, 150) # → -25.0 (25% decrease)
4040
```
4141

42-
### `difference` Difference Between Two Values
42+
### `difference`: Difference Between Two Values
4343
```python
4444
from percentify import difference
4545

4646
difference(10, 20) # → 66.67
4747
difference(50, 50) # → 0.0
4848
```
4949

50-
### `split` Split a Total by Weights
50+
### `split`: Split a Total by Weights
5151
```python
5252
from percentify import split
5353

5454
split(200, [1, 3]) # → [50.0, 150.0]
5555
split(100, [1, 1, 1]) # → [33.33, 33.33, 33.33]
5656
```
5757

58-
### `display` Format as a String
58+
### `display`: Format as a String
5959
```python
6060
from percentify import display
6161

@@ -70,11 +70,11 @@ display(change(100, 20)) # → "-80.0%"
7070

7171
---
7272

73-
## 📊 Beyond Percentages Data Science & Analytics
73+
## 📊 Beyond Percentages; Data Science & Analytics
7474

7575
The functions below replace multi-step, hard-to-remember imports from scipy, statsmodels, and sklearn with a single line.
7676

77-
### `vif`Variance Inflation Factor
77+
### `vif`: Variance Inflation Factor (MultiCollinearity)
7878
Currently buried in `statsmodels.stats.outliers_influence`. One line instead of six.
7979
```python
8080
from percentify import vif
@@ -86,7 +86,7 @@ vif(df, flag=5.0)
8686
# → only columns with VIF > 5 (multicollinearity warnings)
8787
```
8888

89-
### `missing` Missing Data Profiling
89+
### `missing`: Easy Missing Data Profiling
9090
No more typing `df.isnull().sum() / len(df) * 100` every time.
9191
```python
9292
from percentify import missing
@@ -95,7 +95,7 @@ missing(df)
9595
# → {"salary": 12.4, "age": 3.1, "name": 0.0}
9696
```
9797

98-
### `cv` Coefficient of Variation
98+
### `cv`: Coefficient of Variation
9999
Not built-in anywhere — one line instead of `df.std() / df.mean() * 100`.
100100
```python
101101
from percentify import cv
@@ -104,7 +104,7 @@ cv(df["salary"]) # → 34.2
104104
cv(df) # → all numeric columns at once
105105
```
106106

107-
### `outliers` Percentage of Outliers (IQR Method)
107+
### `outliers`: Percentage of Outliers (IQR Method)
108108
Stop rewriting the IQR calculation from scratch.
109109
```python
110110
from percentify import outliers
@@ -113,14 +113,14 @@ outliers(df["salary"]) # → 4.7
113113
outliers(df) # → all numeric columns
114114
```
115115

116-
### `r_squared` R-Squared
116+
### `r_squared`: R-Squared
117117
```python
118118
from percentify import r_squared
119119

120120
r_squared(y_true, y_pred) # → 87.3
121121
```
122122

123-
### `variance_explained` PCA Variance Breakdown
123+
### `variance_explained`: PCA Variance Breakdown
124124
```python
125125
from percentify import variance_explained
126126

0 commit comments

Comments
 (0)