.. _interfaces:

Excel and CSV interfaces
************************

`effectus` comes with program line binaries to work directly with:

  * CSV files
  * an Excel selection

+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:class:`~effectus.Effects` Attribute or Method   | :ref:`Command Line (CSV) <csv>`               | :ref:`Command Line (Excel) <excel>`              |
+=====================================================+===============================================+==================================================+
| :py:attr:`~effectus.Effects.summary`                | :ref:`make_summary <make_summary>`            | :ref:`make_summary_xl <make_summary_xl>`         |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:meth:`~effectus.Effects.the_rule`               | :ref:`the_rule <the_rule>`                    | :ref:`the_rule_xl <the_rule_xl>`                 |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:meth:`~effectus.Effects.attain_causes`          | :ref:`attain_causes <attain_causes>`          | :ref:`attain_causes_xl <attain_causes_xl>`       |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:meth:`~effectus.Effects.attain_effects`         | :ref:`attain_effects <attain_effects>`        | :ref:`attain_effects_xl <attain_effects_xl>`     |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:meth:`~effectus.Effects.separate_causes`        | :ref:`separate_causes <separate_causes>`      | :ref:`separate_causes_xl <separate_causes_xl>`   |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+
| :py:meth:`~effectus.Effects.separate_effects`       | :ref:`separate_effects <separate_effects>`    | :ref:`separate_effects_xl <separate_effects_xl>` |
+-----------------------------------------------------+-----------------------------------------------+--------------------------------------------------+

CSV Files
=========

Run the program :program:`make_summary` on the program line directly on a CSV file:

.. code-block:: bash

  $ curl -O https://bitbucket.org/hyllos/effectus-python/raw/default/effectus/data/missing_teeth.csv
  $ make_summary missing_teeth.csv
  Pareto         True
  Ratio          0.917
  Causes         1/5
  Effects        2/3
  Variability    0.04

If there is only one column, it will consider each value as such.

If there is more than one column, it will consider the second as the frequency of the values in the first (the last example).
   
If the third column carries the frequencies, use ``--frequencies 3``. The option ``--observations`` works accordingly.
If you use ``--frequencies -1``, no frequencies will be considered at all (each observation is counted once).

.. currentmodule:: effectus.helpers

.. note::

    Use :py:func:`~effectus.helpers.write_reduced_values` to reduce values to value frequency mappings and write them to a CSV file.

Excel Selection
===============

If you have one column with values or one with values and another with frequencies, select them and execute on the program line

.. code-block:: bash

    $ make_summary_xl
    Pareto         True
    Ratio          0.917
    Causes         1/5
    Effects        2/3
    Variability    0.04

Watch a `video tutorial <https://youtu.be/eymcGbplVUg>`_.