Skip to content

Commit 26e6537

Browse files
committed
docs: modernize docs homepage with badges, feature matrix, and flow diagram
1 parent 0d7a619 commit 26e6537

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

docs/index.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,59 @@
11
# Welcome to StatClean
22

3-
A comprehensive statistical data preprocessing and outlier detection library with formal statistical testing and publication-quality reporting.
3+
Data preprocessing & outlier detection with formal statistical methods and publication-quality reporting.
4+
5+
[![PyPI](https://img.shields.io/pypi/v/statclean.svg)](https://pypi.org/project/statclean/)
6+
[![Build](https://github.com/SubaashNair/StatClean/actions/workflows/pages.yml/badge.svg)](https://github.com/SubaashNair/StatClean/actions)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../LICENSE)
8+
9+
> Note: Remover methods return `self`. Access cleaned data via `cleaner.clean_df` and details via `cleaner.outlier_info`.
410
511
## Quick Start
612

7-
```python
13+
```bash
814
pip install statclean
915
```
1016

1117
```python
1218
from statclean import StatClean
1319
import pandas as pd
1420

15-
# Your data
1621
df = pd.DataFrame({'values': [1, 2, 3, 100, 4, 5]})
17-
18-
# Initialize StatClean
1922
cleaner = StatClean(df)
20-
21-
# Detect and remove outliers
2223
cleaner.remove_outliers_zscore('values')
23-
cleaned_data = cleaner.clean_df
24+
cleaned_df = cleaner.clean_df
2425
```
2526

26-
## Features
27-
28-
- **Formal Statistical Testing**: Grubbs' test, Dixon's Q-test with p-values
29-
- **Multivariate Analysis**: Mahalanobis distance outlier detection
30-
- **Data Transformations**: Box-Cox, logarithmic, square-root transformations
31-
- **Method Chaining**: Fluent API for streamlined workflows
32-
- **Publication-Quality Reporting**: Statistical significance testing
27+
## Feature Overview
28+
29+
| Feature | Univariate | Multivariate | Formal Test |
30+
|---|---:|---:|---:|
31+
| IQR || | |
32+
| Z-score || | |
33+
| Modified Z-score || | |
34+
| Mahalanobis | || |
35+
| Grubbs || ||
36+
| Dixon Q || ||
37+
38+
## How It Flows
39+
40+
```mermaid
41+
flowchart LR
42+
A[DataFrame] --> B[Analyze Distribution]
43+
B --> C{Recommend Method}
44+
C --> D[IQR / Z / Modified Z]
45+
C --> E[Mahalanobis]
46+
D --> F[Remove / Winsorize]
47+
E --> F
48+
F --> G[Report & Plots]
49+
```
3350

3451
## Navigation
3552

36-
- [API Reference](api-reference.md)
37-
- [Statistical Methods](statistical-methods.md)
38-
- [Examples](examples.md)
3953
- [Installation Guide](installation.md)
54+
- [Quick Start Examples](examples.md)
55+
- [Statistical Methods](statistical-methods.md)
56+
- [API Reference](api-reference.md)
4057

4158
## Links
4259

0 commit comments

Comments
 (0)