Metadata-Version: 2.0
Name: effectus
Version: 1.0.0.dev2
Summary: effectus tells you which minority of causes provokes which majority of effects.
Home-page: http://bitbucket.com/hyllos/effectus-python
Author: Benjamin Weber
Author-email: mail@bwe.im
License: MIT license
Keywords: pareto cause-effect power-law entropy
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: click
Requires-Dist: quicktions
Requires-Dist: xlwings

effectus - A cause-effect library
=================================

.. image:: https://img.shields.io/pypi/v/effectus.svg
  :target: https://https://pypi.python.org/pypi/effectus
  :alt: Pypi version

.. image:: https://img.shields.io/pypi/pyversions/effectus.svg
  :target: https://pypi.python.org/pypi/effectus
  :alt: Python versions

.. image:: https://img.shields.io/appveyor/ci/hyllos/effectus-python/default.svg
  :target: https://ci.appveyor.com/project/hyllos/effectus-python
  :alt: Windows Built Status

.. image:: https://img.shields.io/codecov/c/bitbucket/hyllos/effectus-python/default.svg
  :target: https://codecov.io/bb/hyllos/effectus-python
  :alt: Code coverage 

What?
-----

You provide it with a series of numbers.
It tells you whether a pareto distribution is present.

Why?
----

``Mean``, ``Median`` and ``Most likely value`` regularly hide that a
minority of causes provokes a majority of effects.

How?
----

First, install it:

.. code-block:: bash

    $ pip3 install effectus

Then, in your Python shell do:

.. code-block:: python

    from effectus.core import make_summary
    make_summary([789, 621, 109, 65, 45, 30, 27, 15, 12, 9])
    {'causes': '1/5',
     'effects': '4/5',
     'pareto': True,
     'ratio': 0.707,
     'variability': 0.02}

If you want 80% of results, you need only 20% of causes.

`» Documentation <http://docs.unterschied.cc/effectus-python>`_
---------------------------------------------------------------


