CorrPlot

class CorrPlot

Correlation plot builder.

The terminal build() method will create a fully configured 'Plot' (i.e. Figure) object.

Notes

To hide axis tooltips, set "blank" or the result of elementBlank() to the axisTooltip, axisTooltipX or axisTooltipY parameter of the theme().

Examples

Parameters

data

Dataframe to compute correlations on.

title

Plot title.

showLegend

default = true. false - do not show legend for this layer.

flip

default = true. Whether to flip the y-axis.

threshold

Minimal correlation abs value to be included in result. Must be in interval [0.0, 1.0].

adjustSize

A scaler to adjust the plot size which was computed by CorrPlot automatically.

Constructors

Link copied to clipboard
constructor(data: Map<*, *>, title: String? = null, showLegend: Boolean = true, flip: Boolean = true, threshold: Double = DEF_THRESHOLD, adjustSize: Double = 1.0)

Functions

Link copied to clipboard
fun build(): Plot
Link copied to clipboard
fun labels(type: String? = null, diag: Boolean? = null, mapSize: Boolean? = null, color: String? = null): CorrPlot

Adds labels layer to corr plot.

Link copied to clipboard

Uses Brewer 'BrBG' colors.

Link copied to clipboard
fun paletteGradient(low: String, mid: String, high: String): CorrPlot

Uses gradient colors.

Link copied to clipboard

Uses Brewer 'PiYG' colors.

Link copied to clipboard

Uses Brewer 'PRGn' colors.

Link copied to clipboard

Uses Brewer 'PuOr' colors.

Link copied to clipboard

Uses Brewer 'RdBu' colors.

Link copied to clipboard

Uses Brewer 'RdGy' colors.

Link copied to clipboard

Uses Brewer 'RdYlBu' colors.

Link copied to clipboard

Uses Brewer 'RdYlGn' colors.

Link copied to clipboard

Uses Brewer 'Spectral' colors.

Link copied to clipboard
fun points(type: String? = null, diag: Boolean? = null): CorrPlot

Adds points layer to corr plot.

Link copied to clipboard
fun tiles(type: String? = null, diag: Boolean? = null): CorrPlot

Adds tiles layer to corr plot.