TaskClust: Cluster Task

In mlr3cluster: Cluster Extension for 'mlr3'

Cluster Task

Description

This task specializes mlr3::Task for cluster problems. As an unsupervised task, this task has no target column. The task_type is set to "clust".

Predefined tasks are stored in the dictionary mlr3::mlr_tasks.

Super classes

mlr3::Task -> mlr3::TaskUnsupervised -> TaskClust

Methods

Public methods

• TaskClust$new()

• TaskClust$clone()

Inherited methods

• mlr3::Task$add_strata()
• mlr3::Task$cbind()
• mlr3::Task$data()
• mlr3::Task$divide()
• mlr3::Task$droplevels()
• mlr3::Task$filter()
• mlr3::Task$format()
• mlr3::Task$formula()
• mlr3::Task$head()
• mlr3::Task$help()
• mlr3::Task$levels()
• mlr3::Task$missings()
• mlr3::Task$print()
• mlr3::Task$rbind()
• mlr3::Task$rename()
• mlr3::Task$select()
• mlr3::Task$set_col_roles()
• mlr3::Task$set_levels()
• mlr3::Task$set_row_roles()

---

Method new()

Creates a new instance of this R6 class.

Usage

TaskClust$new(id, backend, label = NA_character_)

Arguments

id

(character(1))
Identifier for the new instance.

backend

(mlr3::DataBackend)
Either a mlr3::DataBackend, or any object which is convertible to a mlr3::DataBackend with as_data_backend(). E.g., a data.frame() will be converted to a mlr3::DataBackendDataTable.

label

(character(1))
Label for the new instance.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TaskClust$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other Task: mlr_tasks_ruspini, mlr_tasks_usarrests

Examples

library(mlr3)
library(mlr3cluster)
task = TaskClust$new("usarrests", backend = USArrests)
task$task_type

# possible properties:
mlr_reflections$task_properties$clust

mlr3cluster documentation built on April 4, 2025, 2 a.m.