Skip to main content

Minimal-tuning CLI tool for data stats and clarity checks

Project description

PyPI version License: MIT

sancheck

sancheck is a minimal-tuning CLI tool for quickly assessing the statistical cleanliness of numeric columns in CSV datasets.
It provides a fast, high-level overview before deeper analysis or modeling.

When should I use it?

  • Before exploratory data analysis (EDA)
  • Before training statistical or machine learning models
  • When you want a quick sanity check without manual inspection

What it does NOT do

  • It does not clean or modify data
  • It does not model relationships
  • It does not replace proper EDA or data validation pipelines

Quick start

Run the tool on a CSV file:

sancheck [csv_dir] [target_column_name] [n_feature_per_plot or 'all']

Example output

📊 Boxplot visualization

Boxplot Example

🔥 Heatmap visualization

Heatmap Example

💬 Terminal output

📊 Dataset Summary

  • Valid numeric columns: 5
  • Ignored non-numeric columns: 2

📌 Column problems

  • Column with NaN/Inf/invalid: 0
    • math_score: invalid=0/10 (0.000)
    • science_score: invalid=0/10 (0.000)
    • english_score: invalid=0/10 (0.000)
    • total_score: invalid=0/10 (0.000)
    • age: invalid=0/10 (0.000)
  • Type inconsistency column: 0
    • math_score: bad_type=0 (0.000)
    • science_score: bad_type=0 (0.000)
    • english_score: bad_type=0 (0.000)
    • total_score: bad_type=0 (0.000)
    • age: bad_type=0 (0.000)
  • Similar feature pairs (|corr| >= 0.95):
    • Severity similarity: 0.996
    • math_score <-> total_score: |corr|=0.998
    • english_score <-> total_score: |corr|=0.993
    • science_score <-> total_score: |corr|=0.992
    • math_score <-> english_score: |corr|=0.990
    • math_score <-> science_score: |corr|=0.988
    • science_score <-> english_score: |corr|=0.972
    • Affected columns: english_score, math_score, science_score, total_score

📌 Row problems

  • Problematic rows (NaN/Inf): 0/10
  • Severity row: 0.141
    • row 2: score=0.667, invalid=False
    • row 3: score=0.594, invalid=False
    • row 5: score=0.580, invalid=False
    • row 6: score=0.576, invalid=False
    • row 7: score=0.555, invalid=False

📌 Distribution and interpretation

  • High entropy means the distribution is more even/complex; it's not automatically 'noise', it can also be multimodal.

  • High spread score means the data is more dispersed robustly compared to its central tendency.

    Top entropy:

    • math_score: entropy=0.960 (very spread / more uniform or complex distribution)
    • science_score: entropy=0.960 (very spread / more uniform or complex distribution)
    • total_score: entropy=0.960 (very spread / more uniform or complex distribution)
    • age: entropy=0.960 (very spread / more uniform or complex distribution)
    • english_score: entropy=0.859 (very spread / more uniform or complex distribution)

    Top spread:

    • science_score: spread_score=0.562 (wide / large variation), var=0.006, iqr=0.092
    • total_score: spread_score=0.538 (wide / large variation), var=0.057, iqr=0.298
    • math_score: spread_score=0.528 (wide / large variation), var=0.007, iqr=0.108
    • english_score: spread_score=0.508 (wide / large variation), var=0.006, iqr=0.103
    • age: spread_score=0.503 (wide / large variation), var=2.222, iqr=2.000

📌 Structure

  • VIF mean (normalized): 0.000 (low)
  • VIF per-feature
    • math_score: VIF=inf
    • science_score: VIF=inf
    • english_score: VIF=inf
    • total_score: VIF=inf
    • age: VIF=123.590
  • sparsity: 0.100 (low)
  • class imbalance ratio: 0.040 (low)
  • class override ratio: 0.000 (low)

📌 Normality

  • Shapiro-wilk and KS test score per-feature:
    • math_score: Shapiro=0.902 | KS=0.997
    • science_score: Shapiro=0.903 | KS=0.970
    • english_score: Shapiro=0.746 | KS=0.987
    • total_score: Shapiro=0.912 | KS=0.975
    • age: Shapiro=0.341 | KS=0.925
  • normality score (based on skewness and kurtosis): 0.838 (very high)

🧼 Cleanineess status

  • cleanliness score: 0.759 / 1.000
  • cleanliness label: fairly clean
  • missing severity: 0.000
  • type severity: 0.000
  • similarity severity: 0.996
  • row severity: 0.141

📊 Dataset-level distribution summary

  • avg entropy: 0.940
  • avg spread score: 0.528

⏱️ Elapsed time: 6.26 seconds (including plot visualization)

Interpretation tips

  • Higher clarity scores indicate cleaner numeric data

  • Anomalous rows are ranked, not classified — use them for inspection

  • Non-numeric columns are ignored by design

  • This tool is best used as a fast pre-analysis step

  • Some metric may produce infinity values for some reason, such as VIF metric if pair of feature has a very high correlation score

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sancheck-0.1.4.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sancheck-0.1.4-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file sancheck-0.1.4.tar.gz.

File metadata

  • Download URL: sancheck-0.1.4.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for sancheck-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f1d1bafab42d1c3d4c37a1fa5f5fa50849c1f325ac60ed352aad6be6f17b549b
MD5 768f7e86898d96da2284018aed0a51de
BLAKE2b-256 999ecb5107dadd3fb72168ed003bf0c7e401a818b63c820f1bb544fb50bcdbf9

See more details on using hashes here.

File details

Details for the file sancheck-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: sancheck-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for sancheck-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d69023eb1f1c2992d5afa1e3ae1515f8538e68548586990ad502c09124631181
MD5 9e7331bc1a93af56f976fc13befee100
BLAKE2b-256 ec6b27201f94663d71fbccf8a093b1624319ff622cbe4a2de34d19923d3f87c8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page