Heatmap

Generalized signature

The specific signature depends on the function, but all functions related to "count2d" statistic (which will be discussed further below — different variations of statCount2D(), heatmap()) have approximately the same signature with the arguments above:

statCount2DArgs :=
   x,
   y,
   weights = null

The possible types of x, y and weights depend on where a certain function is used. They can be simply Iterable (List, Set, etc.) or a reference to a column in a DataFrame (String, ColumnAccessor) or the DataColumn itself. x elements are type of X — generic type parameter, y elements are type of Y — generic type parameter.

statCount2D plot transform

statCount2D(statCount2DArgs) { /*new plotting context*/ } modifies a plotting context — instead of original data (no matter was it empty or not) new statCount2D dataset (calculated on given arguments; inputs and weights can be provided as Iterable or as dataset column reference - by name as a String, as a ColumnReference or as a DataColumn) is used inside a new context (original dataset and primary context are not affected — you can add layers using initial dataset outside the statCount2D context). Since the old dataset is irrelevant, we cannot use references for its columns. But we can refer to the new ones. They are all contained in the Stat group and can be called inside the new context:

df.plot {
    statCount2D(`class`, drv) {
        // New `StatCount` dataset here
        points {
            // Use `Stat.*` columns for mappings
            x(Stat.x) {
                axis.expand(0.0, 0.5)
            }
            y(Stat.y)
            size(Stat.count) {
                scale = continuous(10.0..30.0)
            }
            color = Color.RED
        }
    }
}

Heatmap layer

Heatmap is a statistical plot used for visualizing the distribution of two categorical variables sample. It's a tile plot where each tile is representing one of a pair of categories: its x coordinate is corresponding to x category, y to y category, and its color is to count of this pair. So basically, we can build a heatmap with statCount2D as follows:

val statCount2DAndTilePlot = df.plot {
    statCount2D("class", "drv") {
        tiles {
            x(Stat.x)
            y(Stat.y)
            fillColor(Stat.count)
        }
    }
    layout.title = "`statCount2D()` + `tile()` layer"
}
statCount2DAndTilePlot

But we can do it even faster with heatmap(statCount2DArgs) method:

val heatmapLayerPlot = df.plot {
    heatmap(`class`, drv)
    layout.title = "`heatmap()` layer"
}
heatmapLayerPlot

Let's compare them:

plotGrid(listOf(statCount2DAndTilePlot, heatmapLayerPlot))

These two plots are identical. Indeed, heatmap just uses statCount2D and tile and performs coordinates and fillColor mappings under the hood. And we can customize heatmap layer: heatmap() optionally opens a new context, where we can configure tiles (as in the usual context opened by tile { ... }) — even change default mappings. StatCount2D dataset of heatmap also can be accessed here.

df.plot {
    heatmap(`class`, drv) {
        // Swap coordinate mappings:
        x(Stat.y)
        y(Stat.x)
        // Default mapping but with custom scale
        fillColor(Stat.count) {
            scale = continuousColorBrewer(BrewerPalette.Sequential.Reds)
        }
    }
}

If we specify weights, Stat.countWeighted is mapped to fillColor by default:

df.plot {
    heatmap(`class`, drv, hwy)
}

heatmap plot

heatmap(statCount2DArgs) and DataFrame.heatmap(statCount2DArgs) are a family of functions for fast plotting a heatmap.

heatmap(
    listOf("A", "A", "A", "B", "B", "C", "B", "B"),
    listOf(1, 1, 1, 2, 1, 2, 1, 2),
)

df.heatmap("class", "drv")

In case you want to provide inputs and weights using column selection DSL, it's a bit different from the usual one — you should assign x and y inputs and (optionally) weight throw invocation eponymous functions:

df.heatmap {
    x(`class`)
    y(drv)
    weight(hwy)
}

Heatmap plot can be configured with .configure {} extension — it opens context that combines tile, StatCount2D and plot context. That means you can configure tile settings, mappings using StatCount2D dataset and any plot adjustments:

df.heatmap {
    x(`class`)
    y(drv)
    weight(hwy)
}.configure {
    // Tile + StatCount2D + PlotBuilder
    // Can't add new layer
    // Can add tile mapping, including for `Stat.*` columns
    fillColor(Stat.count) {
        scale = continuous(Color.GREEN..Color.RED)
    }
    alpha = 0.6
    // Can configure general plot adjustments
    layout {
        title = "Configured `heatmap` plot"
        size = 600 to 350
    }
}