effectus: a cause-effect library
********************************

What?
=====

`effectus` tells you which causes provoke which effects:

.. code-block:: python

  >>> from effectus import Effects
  >>> Effects([789, 621, 109, 65, 45, 30, 27, 15, 12, 9])
  <pareto present [0.707]: 1/5 causes => 4/5 effects [total ∆: 1.9 % points]>

Why?
====

Few values of high intensity distort the result of the :ref:`arithmetic mean <arithmetic-mean>` for most values of low intensity and vice versa.

Guided by the :ref:`arithmetic mean <arithmetic-mean>` one regularly misunderstands it as something like the most likely value where it would be better
called the most unlikely value.

How?
====

A cause-effect relationship is easier to communicate yet preciser. As it unveils the true power behind things, it transforms resistance into pleasure for action. If you want to achieve more with less, this might be something for you.

`effectus` operationalises the :func:`~effectus.pareto.entropy` model proposed by Ronen et al. [2007]_.
It adds a routine to approximate the most relevant cause-effect relationship.
Its main class :class:`~effectus.Effects` provides methods to return any effect or cause for any given cause or effect.
:ref:`Interval <intervals>` functions allow to intersect and subtract values of two different attributes.
You can :ref:`intersect <intersections>` results and effort to increase the effectiveness by orders of magnitude.

It comes with an :ref:`Excel interface <excel>` and binaries to parse :ref:`CSV files <csv>` directly.

*Is all that too complicated for you?*

Then just paste your data into this `web service <http://pardect.unterschied.cc>`_ and get instant results (summary only).


.. [2007] Grosfeld-Nir, A.; Ronen, B.; Kozlovsky, N. `The Pareto managerial principle: when does it apply?, International Journal of Production Research, Vol. 45, No. 10, 15 May 2007, 2317—2325 <http://www.boazronen.org/PDF/The%20Pareto%20managerial%20principle%20-%20when%20does%20it%20apply.pdf>`_

.. toctree::
    :maxdepth: 2
    :hidden:

    quickstart
    features
    tutorials
    exercises
    data-handling
    interfaces
    example-data
    arithmetic-mean
    applications
    glossary
    api
    changes
    genindex