Quantile
========

A :doc:`Callable </Callables/Callable>` for returning a quantile of a column.

Definition
----------

.. py:class:: controller.callable.transformer.Median(self, column: ColumnReference, quantile: float, output_name: str, output_list: list[str])

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

    :param column: A column reference where the values in the column are used to calculate the specified quantile.
    :type column: ColumnReference
    :param quantile: The quantile to return. Range: :math:`[0, 1]`
    :type quantile: float
    :param output_name: The name of the new column containing the Callable output.
    :type output_name: str
    :param output_list: A list of columns to return.
    :type output_list: list[str]

Parameters
----------

.. py:attribute:: column

    A column reference where the values in the column are used to calculate the specified quantile.

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

.. py:attribute:: quantile

    The quantile to return. Range: :math:`[0, 1]`

    :type: float
    :required: True

.. py:attribute:: output_name

    The name of the new column containing the Callable output.

    :type: str
    :required: True

.. 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 column created by this Callable

Output
------

A DataFrame is returned where it contains all columns specified in the ``output_list``, potentially including a new column with the name ``<callable_id>.<output_name>``.

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

.. code-block:: javascript

    {
        "name": "foo",
        "callable": "quantile",
        "params": {
            "column": "$get_submissions.submission.score",
            "quantile": 0.25,
            "output_name": "25_quantile_score",
            "output_list": [
                "get_submissions.submission.id", 
                "get_submissions.submission.score", 
                "foo.25_quantile_score"
            ]
        }
    }