Metadata-Version: 2.1
Name: abc-analysis
Version: 0.1.23
Summary: ABC analysis with automated limit detection
Download-URL: https://github.com/viessmann/abc_analysis/archive/v0.1.22.tar.gz
Author: Viessmann
Author-email: ghlt@viessmann.com
License: GNU General Public License v3 (GPLv3)
Project-URL: Viessmann, https://www.linkedin.com/company/viessmann/
Project-URL: Source, https://github.com/viessmann/abc_analysis
Keywords: abc-analysis abc_analysis Viessmann
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
License-File: LICENSE.txt
Requires-Dist: pandas (>=0.22)
Requires-Dist: numpy (>=1.14)
Requires-Dist: scipy (>=1.1.0)
Requires-Dist: matplotlib (>=2.2.2)

ABC analysis
============

Performs and visualizes an ABC analysis with automated limit detection. 

This package is a Python implementation of the R package `ABCanalysis <https://CRAN.R-project.org/package=ABCanalysis>`_.

The package is based on "Computed ABC Analysis for rational Selection of most informative Variables in multivariate Data", PLoS One. Ultsch. A., Lotsch J. (2015) `doi:10.1371/journal.pone.0129767 <https://doi.org/10.1371/journal.pone.0129767>`_.

Basic Usage
^^^^^^^^^^^

.. code-block:: python

    from abc_analysis import abc_analysis, abc_plot
    
    # Perform an ABC analysis on a numeric vector (without plotting)
    dctAnalysis = abc_analysis([1, 15, 25, 17, 2, 3, 5, 6, 2, 3, 22])
    
    # Perform an ABC analysis with plotting
    dctAnalysis = abc_analysis([1, 15, 25, 17, 2, 3, 5, 6, 2, 3, 22], True)
    
    # Plot saved results of an ABC analysis
    abc_plot(dctAnalysis)


