Regression Plot
===============

A :doc:`Callable </Callables/Callable>` for generating a regression plot.

Definition
----------

.. py:class:: controller.callable.outputter.RegressionPlot(self, column_names: list[ColumnReference], title: str)

    :callable name: ``regression_plot``
    :callable type: :doc:`Outputter </Callables/Types/Outputter>`

    :param x: A column reference to find values for the x-axis. 
    :type x: ColumnReference
    :param y: A column reference to find values for the y-axis. 
    :type y: ColumnReference
    :param title: The title of the plot.
    :type title: str
    :param x_axis_name: The name of the x-axis.
    :type x_axis_name: str
    :param y_axis_name: The name of the y-axis.
    :type y_axis_name: str

Parameters
----------

.. py:attribute:: x

    A column reference to find values for the x-axis. 

    :type: ColumnReference
    :required: True
    :choices: All columns in the target DataFrame
    
.. py:attribute:: y

    A column reference to find values for the y-axis. 

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

.. py:attribute:: title

    The title of the plot.

    :type: str
    :required: True

.. py:attribute:: x_axis_name

    The name of the x-axis.

    :type: str
    :required: True

.. py:attribute:: y_axis_name

    The name of the y-axis.

    :type: str
    :required: True

Output
------

A DataFrame is returned where it contains two columns matching the output conventions of an Outputter.

- The ``data`` column contains the generated regression chart in PNG format.
- The ``type`` column indicates the data type to be ``image/png``.

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

.. code-block:: javascript

    {
        "name": "foo",
        "callable": "regression_plot",
        "params": {
            "x": "$final_exam_means.course_year_numeric",
            "y": "$final_exam_means.means",
            "title": "Final Exam Means",
            "x_axis_name": "Year",
            "y_axis_name": "Mean"
        }
    }