as_task_clust: Convert to a Cluster Task

In mlr3cluster: Cluster Extension for 'mlr3'

Convert to a Cluster Task

Description

Convert object to a TaskClust or a list of TaskClust. This is a S3 generic, specialized for at least the following objects:

1. TaskClust: returns the object as-is, possibly cloned.

2. formula, data.frame(), matrix(), and mlr3::DataBackend: provides an alternative to the constructor of TaskClust.

Usage

as_task_clust(x, ...)

## S3 method for class 'TaskClust'
as_task_clust(x, clone = FALSE, ...)

## S3 method for class 'data.frame'
as_task_clust(x, id = deparse1(substitute(x)), label = NA_character_, ...)

## S3 method for class 'matrix'
as_task_clust(x, id = deparse1(substitute(x)), label = NA_character_, ...)

## S3 method for class 'DataBackend'
as_task_clust(x, id = deparse1(substitute(x)), label = NA_character_, ...)

## S3 method for class 'formula'
as_task_clust(
  x,
  data,
  id = deparse1(substitute(data)),
  label = NA_character_,
  ...
)

as_tasks_clust(x, ...)

## S3 method for class 'list'
as_tasks_clust(x, clone = FALSE, ...)

## S3 method for class 'TaskClust'
as_tasks_clust(x, clone = FALSE, ...)

Arguments

x	(any) Object to convert.
...	(any) Additional arguments.
clone	(logical(1)) If TRUE, ensures that the returned object is not the same as the input x.
id	(character(1)) Id for the new task. Defaults to the (deparsed and substituted) name of the data argument.
label	(character(1)) Label for the new instance.
data	(data.frame()) Data frame containing all columns specified in formula x.

Value

TaskClust.

Examples

as_task_clust(datasets::USArrests)

mlr3cluster documentation built on Sept. 17, 2026, 5:09 p.m.