Skip to main content

​
Usage

The following shows how the step can be used in a recipe.

Examples

  • Signature
General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.
create_correlations_insight(, {
    "param": value,
    ...
})

​
Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").

​
Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

​
title
string
required
Title of the insight.
​
columnX
string
Name of the column that will be compared with other columns specified in the correlatedColumns parameter. Placed in the x axis.
​
columnY
string
Name of the column that will be compared with other columns specified in the correlatedColumns parameter Placed in the y axis.
​
correlatedColumns
array[string]
required
A list of columns the columnX or columnY will be compared with. The insight will contain one chart per correlated column. If columnX and columnY are provided correlatedColumns needs to contain only columnY.
​
Item
string
Each item in array.
​
hiddenColumns
array[string]
Columns hidden from the Correlations section when the insight is replayed. When replayed, the Correlation section will compare the target variable with all variables in the dataset except these.
​
Item
string
Each item in array.
​
insightThemeMode
string
Theme mode applied to the whole insight.Values must be one of the following:
  • dark
  • light
​
isExpanded
boolean
Sets the correlation graph as expanded. If true, the insight will contain an expanded chart in order to show the maximum number of categories possible.
​
replayDisabled
[string, boolean]
default:"false"
Indicates if the insight can replay its original state or not.Values must be one of the following:
  • drillDown
  • directSelectionInGraph
  • nonPersistedColumn
  • True
  • False
​
representation
string
required
Sets the visualization type. Whether a heatmap or a bubble like chart.Values must be one of the following:
  • heatmap
  • bubble
​
isBoxplot
boolean
Sets Boxplot as visualization type. If true, a combination of quantitative & categorical columns will use Boxplot as visualization type.
​
elements
array[object]
Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.
​
kind
string
Specify the type of element.Values must be one of the following:TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHART
​
text
string
The text shown for this insight element.
​
hidden
boolean
Element visibility.
​
layout
object
The element’s position and size. The position refers to the top-left corner of the rectangle representing the insight element, while the size is given by its width and height. For reference, the entire insight is 12 units wide and 9 units high, and the origin (0, 0) of the x/y coordinates is in its top-left corner.
​
x
integer
Horizontal position of the element’s top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:
-1 ≤ x ≤ 11
​
y
integer
Vertical position of the element’s top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:
0 ≤ y ≤ 11
​
w
integer
The width of the element (in increments of 1).Values must be in the following range:
0 ≤ w ≤ 12
​
h
integer
The height of the element (in increments of 1).Values must be in the following range:
0 ≤ h ≤ 9
​
column
string
Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.
⌘I