.. _excel:

Excel Interface
***************

`effectus` comes with binaries that read directly from a selection in Excel.

There is absolutely no need to export your data from Excel.

Example
=======

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

.. code-block:: bash

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


Command Reference
=================

Consider the `video tutorial <https://youtu.be/eymcGbplVUg>`_ for a short demo.

No binary takes a file as argument. Configurations may happen through options.

.. _make_summary_xl:

:program:`make_summary_xl [OPTIONS]`
------------------------------------

.. program:: make_summary_xl

.. option:: -h, --help

   Display usage summary.

.. _the_rule_xl:

:program:`the_rule_xl [OPTIONS]`
------------------------------------

.. program:: the_rule_xl

.. option:: -h, --help

   Display usage summary.

.. _attain_causes_xl:

:program:`attain_causes_xl [OPTIONS]`
-------------------------------------

.. program:: attain_causes

.. option:: -l, --limit

   Causes ratio between 0 and 1 to attain.

.. option:: -d, --delimiter

   Column delimiter (default: ',')

.. option:: -p, --precision

   Number of decimals to show (default: 3)

.. option:: -a, --ascending

   Cumulate values from smallest to biggest (default: biggest to smallest).

.. option:: -h, --help

   Display usage summary.

.. _attain_effects_xl:

:program:`attain_effects_xl [OPTIONS]`
--------------------------------------

.. program:: attain_effects

.. option:: -l, --limit

   Effects ratio between 0 and 1 to attain.

.. option:: -d, --delimiter

   Column delimiter (default: ',')

.. option:: -p, --precision

   Number of decimals to show (default: 3)

.. option:: -a, --ascending

   Cumulate values from smallest to biggest (default: biggest to smallest).

.. option:: -h, --help

   Display usage summary.

.. _separate_causes_xl:

:program:`separate_causes_xl [OPTIONS]`
---------------------------------------

.. program:: separate_causes

.. option:: -l, --limit

   Causes ratio between 0 and 1 to attain (default: 0.2)

.. option:: -d, --delimiter

   Column delimiter (default: ',')

.. option:: -p, --precision

   Number of decimals to show (default: 3)

.. option:: -a, --ascending

   Cumulate values from smallest to biggest (default: biggest to smallest).

.. option:: -h, --help

   Display usage summary.

.. _separate_effects_xl:

:program:`separate_effects_xl [OPTIONS]`
----------------------------------------

.. program:: separate_effects

.. option:: -l, --limit

   Effects ratio between 0 and 1 to attain (default: 0.2)

.. option:: -d, --delimiter

   Column delimiter (default: ',')

.. option:: -p, --precision

   Number of decimals to show (default: 3)

.. option:: -a, --ascending

   Cumulate values from smallest to biggest (default: biggest to smallest).

.. option:: -h, --help

   Display usage summary.