Skip to main content

A package for doing great things!

Project description

snapedautility

ci-cd [Documentation Status]

codecov

snapedautility is an open-source library that generate useful function to kickstart EDA (Exploratory Data Analysis) with just a few lines of code. The system is built around quickly analyzing the whole dataset and providing a detailed report with visualization. Its goal is to help quick analysis of feature characteristics, detecting outliers from the observations and other such data characterization tasks.

Features

  1. plot_histograms: Plots the distribution for numerical, categorical and text features
  2. detect_outliers: Generate a violin plot that indicates the outliers that deviate from other observations on data.
  3. plot_corr: Generates Correlation Plots for numerical (Pearson's correlation), categorical (uncertainty coefficient) and categorical-numerical (correlation ratio) datatypes seamlessly for all data types.

Installation

$ pip install snapedautility

Usage

plot_histograms

>>> from snapedautility.plot_histograms import plot_histograms
>>> df = penguins_data
>>> plot_histograms(df, ["Culmen Length (mm)", "Culmen Depth (mm)", 'Species'], 100, 100)

plot_corr

>>> from snapedautility.plot_corr import plot_corr
>>> df = penguins_data
>>> plot_corr(df, ["Culmen Length (mm)", "Culmen Depth (mm)", 'Species'])

detect_outliers

>>> from snapedautility.detect_outliers import detect_outliers 
>>> s = pd.Series([1,1,2,3,4,5,6,9,10,13,40])
>>> detect_outliers(s)

Documentation

The official documentation is hosted on Read the Docs: https://snapedautility.readthedocs.io/

Contributors

Core contributor Github.com username
Kyle Ahn @AraiYuno
Harry Chan @harryyikhchan
Dongxiao Li @dol23asuka

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

Similar Work

We recognize EDA (exploratory data analysis) and preprocessing packages are common in the Python open source ecosystem. Our package aims to do a few things very well, and be light weight. A non exhaustive list of EDA helper packages in Python include:

  • pandasprofiling
    • This was the original inspiration for this project. We would like to expand the functionalities on this project.
  • sweetviz
    • This package produces very clean visuals detailing breakdowns in descriptive statistics and can do so with train/test sets for model building workflows.
  • ExploriPy
    • This packages does the most common EDA tasks but also adds in the ability to do statistical testing using analysis of variance (ANOVA), Chi Square test of independence etc.

License

snapedautility was created by Kyle Ahn, Harry Chan and Dongxiao Li. It is licensed under the terms of the MIT license.

Credits

snapedautility was created with cookiecutter and the py-pkgs-cookiecutter template.

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

snapedautility-0.1.5.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

snapedautility-0.1.5-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file snapedautility-0.1.5.tar.gz.

File metadata

  • Download URL: snapedautility-0.1.5.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for snapedautility-0.1.5.tar.gz
Algorithm Hash digest
SHA256 2864082cf2e71e6d5157c4db272e0b03e409117e0059a9559485eedb0bf71731
MD5 785f8953da97523bbcfaf51f2a928710
BLAKE2b-256 76f7a2dbb2bf0ccf3ce48f548e9a6acaf2d970ba8e72cc2d9b4c8a1286ffd3a4

See more details on using hashes here.

File details

Details for the file snapedautility-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: snapedautility-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for snapedautility-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bca5fa4eb808185f2775c8017245ce3623962a32f7fb0ea48a0050e18b82b228
MD5 0464f1571a73b7919d24faaa1fd0e797
BLAKE2b-256 b84db9881128e2a703db7b10cd7351c84d127145d94d302445b6004420eb6a76

See more details on using hashes here.

Supported by

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