create_correlations_insight
Create a new insight from the Correlations section.
Usage
The following shows how the step can be used in a recipe.
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.
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.
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).
Title of the insight.
Name of the column that will be compared with other columns specified in the correlatedColumns parameter. Placed in the x axis.
Name of the column that will be compared with other columns specified in the correlatedColumns parameter Placed in the y axis.
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.
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.
Theme mode applied to the whole insight.
Values must be one of the following:
darklight
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.
Indicates if the insight can replay its original state or not.
Values must be one of the following:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse
Sets the visualization type. Whether a heatmap or a bubble like chart.
Values must be one of the following:
heatmapbubble
Sets Boxplot as visualization type. If true, a combination of quantitative & categorical columns will use Boxplot as visualization type.
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.