Skip to content

Commit bc71794

Browse files
authored
Fix punctuation and formatting in README.md
Corrected punctuation and formatting for clarity throughout the README.
1 parent 70167ac commit bc71794

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[![License](https://img.shields.io/pypi/l/percentify.svg?style=flat&color=orange)](LICENSE)
77
[![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)
88

9-
**Percentify a niche data science library for practitioners and learners alike, drawing its main dependencies from pandas and numpy, and including everyday statistics.**
9+
**Percentify is a niche data science library for practitioners and learners alike, drawing its main dependencies from pandas and numpy, and including everyday statistics.**
1010

11-
Following the **Pareto principle**, Percentify brings the 20% of operations that make up 80% of daily data work to the forefront each as a single, readable function call. No more digging through six-line recipes and hard-to-remember import paths for the checks you run on every dataset.
11+
Following the **Pareto principle**, Percentify brings the 20% of operations that make up 80% of daily data work to the forefront, each as a single, readable function call. No more digging through six-line recipes and hard-to-remember import paths for the checks you run on every dataset.
1212

13-
Percentify **does not aim to compete** with pandas, scipy, statsmodels, or scikit-learn it stands on their shoulders and works *alongside* them. The goal is to make the core concepts easy to learn, quick to use, and simple to remember. Every function names the underlying library it draws from, so the moment you need the full, configurable version, you know exactly where to go.
13+
Percentify **does not aim to compete** with pandas, scipy, statsmodels, or scikit-learn; it stands on their shoulders and works *alongside* them. The goal is to make the core concepts easy to learn, quick to use, and simple to remember. Every function names the underlying library it draws from, so the moment you need the full, configurable version, you know exactly where to go.
1414

1515
Every function takes a pandas `DataFrame` (or `Series`) and hands back a clean `DataFrame` you can read, sort, or feed straight into the next step.
1616

@@ -27,7 +27,7 @@ Requires `numpy` and `pandas`.
2727

2828
## 📊 The Toolkit
2929

30-
### `change` Percentage Change
30+
### `change`: Percentage Change
3131
Two numbers, two columns, or a whole series at once.
3232
> _Underlying library:_ `pandas.DataFrame.pct_change`
3333
```python
@@ -45,7 +45,7 @@ change(df["revenue"]) # period-over-period % change down the co
4545
change(df) # every numeric column at once
4646
```
4747

48-
### `vif` Variance Inflation Factor (Multicollinearity)
48+
### `vif`: Variance Inflation Factor (Multicollinearity)
4949
The classic multicollinearity check, without the six-line loop.
5050
> _Underlying library:_ `statsmodels.stats.outliers_influence.variance_inflation_factor`
5151
```python
@@ -60,7 +60,7 @@ vif(df)
6060
vif(df, flag=5.0) # only rows above the threshold (your problem columns)
6161
```
6262

63-
### `missing` Missing Data Profiling
63+
### `missing`: Missing Data Profiling
6464
No more `df.isnull().sum() / len(df) * 100`.
6565
> _Underlying library:_ `pandas.DataFrame.isna`
6666
```python
@@ -73,7 +73,7 @@ missing(df)
7373
# 2 name 0.00
7474
```
7575

76-
### `cv` Coefficient of Variation
76+
### `cv`: Coefficient of Variation
7777
Relative variability (std ÷ mean), as a percentage.
7878
> _Underlying library:_ `scipy.stats.variation`
7979
```python
@@ -83,7 +83,7 @@ cv(df["salary"]) # → 34.2 (a single Series returns a number)
8383
cv(df) # → DataFrame of every numeric column, most variable first
8484
```
8585

86-
### `outliers` Percentage of Outliers (IQR Method)
86+
### `outliers`: Percentage of Outliers (IQR Method)
8787
Stop rewriting the IQR bounds from scratch.
8888
> _Underlying library:_ `scipy.stats.iqr`
8989
```python
@@ -93,15 +93,15 @@ outliers(df["salary"]) # → 4.7
9393
outliers(df) # → DataFrame of every numeric column
9494
```
9595

96-
### `r_squared` R-Squared
96+
### `r_squared`: R-Squared
9797
```python
9898
from percentify import r_squared
9999

100100
r_squared(y_true, y_pred) # → 87.3
101101
```
102102
> _Underlying library:_ `sklearn.metrics.r2_score`
103103
104-
### `pca_variance` PCA Variance Breakdown
104+
### `pca_variance`: PCA Variance Breakdown
105105
Columns are standardized by default, so a feature measured in large units (e.g.
106106
dollars) can't dominate the result just because of its scale. Pass
107107
`standardize=False` for covariance-based PCA on the raw values.
@@ -151,4 +151,4 @@ If your idea keeps things that simple and direct:
151151
- Commit your changes
152152
- Open a pull request
153153

154-
Anything that adds knobs and options for their own sake, or duplicates what the parent libraries already do well, is out of scope those cases should point to the source library instead.
154+
> Anything that adds knobs and options for their own sake, or duplicates what the parent libraries already do well, is out of scope please those cases should point to the source library instead.

0 commit comments

Comments
 (0)