Correlation Plot

A Callable for generating a pairwise correlation plot (heatmap).

Definition

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

Callable name:

correlation_plot

Callable type:

Outputter

Parameters:

column_names (list[ColumnReference]) – A list of column references where the selected columns are compared for pairwise correlation.
title (str) – The title of the plot.

Parameters

column_names

A list of column references where the selected columns are compared for pairwise correlation.

Type:: list[ColumnReference]
Required:: True
Choices:: All columns in the target DataFrame

title

The title of the plot.

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 correlation plot (heatmap) in PNG format.
The type column indicates the data type to be image/png.

Example configuration

{
    "name": "foo",
    "callable": "correlation_plot",
    "params": {
        "column_names": [
            "$get_students_submissions.student.admission_year"
            "$get_students_submissions.student.program"
            "$get_students_submissions.submission.score"
        ],
        "title": "Correlation"
    }
}