Plot for PredictionClust — autoplot.PredictionClust • mlr3viz

Generates plots for mlr3cluster::PredictionClust, depending on argument type:

"scatter" (default): scatterplot with correlation values and colored cluster assignments.
"sil": Silhouette plot with mean silhouette value as a reference line. Requires package ggfortify.
"pca": Perform PCA on data and color code cluster assignments. Inspired by and uses ggfortify::autoplot.kmeans.

Usage

# S3 method for PredictionClust
autoplot(object, task, row_ids = NULL, type = "scatter", ...)

Arguments

object: (mlr3cluster::PredictionClust).
task: (mlr3cluster::TaskClust).
row_ids: row ids to subset task data to ensure that only the data used to make predictions are shown in plots.
type: (character(1)):
Type of the plot. See description.
...: (any): Additional arguments, passed down to the respective geom.

Value

ggplot2::ggplot() object.

Theme

The theme_mlr3() and viridis color maps are applied by default to all autoplot() methods. To change this behavior set options(mlr3.theme = FALSE).

References

Tang Y, Horikoshi M, Li W (2016). “ggfortify: Unified Interface to Visualize Statistical Result of Popular R Packages.” The R Journal, 8(2), 474--485. doi: 10.32614/RJ-2016-060 .

Examples

library(mlr3)
library(mlr3cluster)
library(mlr3viz)

task = tsk("usarrests")
learner = lrn("clust.kmeans", centers = 3)
object = learner$train(task)$predict(task)

head(fortify(object))
#>    row_ids partition
#> 1:       1         1
#> 2:       2         1
#> 3:       3         1
#> 4:       4         3
#> 5:       5         1
#> 6:       6         3
autoplot(object, task)
#> Warning: Factor variables are omitted in plot