T-Test
========

A :doc:`Callable </Callables/Callable>` for performing T-Test on two columns and returning its results.

Definition
----------

.. py:class:: controller.callable.transformer.TTest(self, column1: str, column2: str, output_names: list[str], output_list: list[str])

    :callable name: ``t_test``
    :callable type: :doc:`Transformer </Callables/Types/Transformer>`

    :param column1: A column reference where the values in the column are used as the first group in the T-Test.
    :type column1: ColumnReference
    :param column2: A column reference where the values in the column are used as the second group in the T-Test.
    :type column2: ColumnReference
    :param output_name: The names of the new columns containing the Callable outputs. 
    :type output_name: list[str]
    :param output_list: A list of columns to return.
    :type output_list: list[str]

Parameters
----------

.. py:attribute:: column1

    A column reference where the values in the column are used as the first group in the T-Test.

    :type: ColumnReference
    :required: True
    :choices: All columns in the target DataFrame

.. py:attribute:: column2

    A column reference where the values in the column are used as the second group in the T-Test.

    :type: ColumnReference
    :required: True
    :choices: All columns in the target DataFrame, except the column selected in ``column1``

.. py:attribute:: output_name

    The names of the new columns containing the Callable outputs.

    :type: list[str]
    :required: True

    - ``output_name[0]`` stores the t-statistic.
    - ``output_name[1]`` stores the p-value.

.. py:attribute:: output_list
    
    A list of columns to return.

    :type: list[str]
    :required: True
    :choices: All columns in the target DataFrame, plus the new columns created by this Callable

Output
------

A DataFrame is returned where it contains all columns specified in the ``output_list``, potentially including new columns with the names ``<callable_id>.<output_names>``.

Example configuration
---------------------

.. code-block:: javascript

    {
        "name": "foo",
        "callable": "t_test",
        "params": {
            "column1": "$get_assignment1_submissions.submission.score",
            "column2": "$get_assignment2_submissions.submission.score",
            "output_name": [
                "ttest_t_statistic",
                "ttest_p_value"
            ]
            "output_list": [
                "get_assignment1_submissions.submission.score", 
                "get_assignment2_submissions.submission.score", 
                "foo.ttest_p_value"
            ]
        }
    }