Histogram

A Callable for generating a histogram.

Definition

class controller.callable.outputter.Histogram(self, x: ColumnReference, title: str, x_axis_name: str, y_axis_name: str)

Callable name:

histogram

Callable type:

Outputter

Parameters:

x (ColumnReference) – A column reference to find values for the x-axis.
title (str) – The title of the chart.
x_axis_name (str) – The name of the x-axis.
y_axis_name (str) – The name of the y-axis.

Parameters

x

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

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

title

The title of the chart.

Type:: str
Required:: True

x_axis_name

The name of the x-axis.

Type:: str
Required:: True

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 histogram in PNG format.
The type column indicates the data type to be image/png.

Example configuration

{
    "name": "foo",
    "callable": "histogram",
    "params": {
        "x": "$get_students_submissions.submission.score",
        "title": "Scores distribution",
        "x_axis_name": "Score",
        "y_axis_name": "Number of students"
    }
}