.. _api:

API Documentation
*******************

Top-level Functions
===================

.. note::
    In most cases the umbrella class :class:`~effectus.Effects` will serve your needs.

.. currentmodule:: effectus

.. autoclass:: Effects

    .. automethod:: the_rule

    .. automethod:: abc

    .. automethod:: groups

    **For a given limit of effects:**

    .. automethod:: attain_effects

    .. automethod:: interval_effects

    .. automethod:: separate_effects

    .. automethod:: retrieve_effects

    **For a given limit of causes:**

    .. automethod:: attain_causes

    .. automethod:: interval_causes

    .. automethod:: separate_causes

    .. automethod:: retrieve_causes

    **Helpers**

    .. automethod:: sorted_effects

    .. automethod:: cml_effects


.. _intervals:

Intervals
=========

.. currentmodule:: effectus.intervals

.. automodule:: effectus.intervals

.. autofunction:: keys_in_effects_interval

.. autofunction:: keys_in_causes_interval

.. autofunction:: effects_intersections

.. _intersections:

Intersections
=============

.. currentmodule:: effectus.intersections

.. autoclass:: REffort
    :members:

.. autoclass:: StatsREffort
    :members:

.. autoclass:: StatsREffortGroups
    :members:
    
Data Helpers
============

.. currentmodule:: effectus.helpers

.. autofunction:: get_data

.. autofunction:: write_values

.. autofunction:: write_unfolded_values

.. autofunction:: write_reduced_values

Low-level Functions
===================

Pareto
------

.. automodule:: effectus.pareto
    :members:

Relations
---------

Functions to create cause-effect relationships, identify the relevant,
determine the nearest rounded cause-effect relation and 
In order of process stage:

.. currentmodule:: effectus.helpers

.. autofunction:: make_relations_new

.. autofunction:: make_relations

.. autofunction:: match_relations

.. autofunction:: pick_best

.. autofunction:: get_enriched

.. autofunction:: enrich_match

.. autofunction:: format_summary

Separator
---------

.. autofunction:: det_causes_ordinal

.. autofunction:: det_effects_ordinal

Subsets
-------

.. autoclass:: Stats

    .. automethod:: mean

    .. automethod:: stdev

    .. automethod:: apply

    .. automethod:: throughput

.. autoclass:: StatsSubSet
    :members:

Data Helpers
------------

.. autofunction:: reduce_values

.. autofunction:: unfold_values

.. autofunction:: get_values_from_csv

.. autofunction:: get_values_by_attribute

.. autofunction:: get_values_for_keys

.. autofunction:: get_sub_dicts_for_keys

.. autofunction:: sort_dict

Intersections
-------------

.. currentmodule:: effectus.intersections

.. autoclass:: AttrSubSet
    :members:

.. autoclass:: Separator
    :members:

.. autofunction:: get_vital_keys

Low-low-level Functions
=======================

The following functions are not intended to be user functions.
However, they are listed here for reference.

Core
----

.. currentmodule:: effectus.core

.. autofunction:: make_summary

.. autofunction:: get_rule

.. autofunction:: triad

.. autofunction:: attain_partial_or_impartial

.. autofunction:: attain_effects

.. autofunction:: attain_causes

.. autofunction:: separate_effects

.. autofunction:: separate_causes

Helpers
-------

.. currentmodule:: effectus.helpers

.. autofunction:: frac_gcd

.. autofunction:: get_gcd

.. autofunction:: find_nearest_bisect

.. autofunction:: decimal_range

.. autofunction:: get_majors

.. autofunction:: get_relevant

.. autofunction:: exclude_causes

.. autofunction:: exclude_effects

.. autofunction:: create_relation

.. autofunction:: which_level

.. autofunction:: create_bounds

.. autofunction:: in_bounds

.. autofunction:: det_delta

.. autofunction:: find_equals_right

.. autofunction:: find_equals_left

.. autofunction:: retrieve_rule

.. autofunction:: tabulate_groups

.. autofunction:: max_decimals

.. autofunction:: sufficient_decimals

Intervals
---------

.. currentmodule:: effectus.intervals

.. autofunction:: get_keys_for_interval

.. autofunction:: create_bounds