mlr_learners_clust.agnes: Agglomerative Hierarchical Clustering Learner

In mlr3cluster: Cluster Extension for 'mlr3'

Agglomerative Hierarchical Clustering Learner

Description

A LearnerClust for agglomerative hierarchical clustering implemented in cluster::agnes(). The predict method uses stats::cutree() which cuts the tree resulting from hierarchical clustering into specified number of groups (see parameter k). The default number for k is 2.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("clust.agnes")
lrn("clust.agnes")

Meta Information

• Task type: “clust”

• Predict Types: “partition”

• Feature Types: “logical”, “integer”, “numeric”

• Required Packages: mlr3, mlr3cluster, cluster

Parameters

Id	Type	Default	Levels	Range
metric	character	euclidean	euclidean, manhattan	-
stand	logical	FALSE	TRUE, FALSE	-
method	character	average	average, single, complete, ward, weighted, flexible, gaverage	-
trace.lev	integer	0		[0, \infty)
k	integer	2		[1, \infty)
par.method	untyped	-		-

Super classes

mlr3::Learner -> mlr3cluster::LearnerClust -> LearnerClustAgnes

Methods

Public methods

• LearnerClustAgnes$new()

• LearnerClustAgnes$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$format()
• mlr3::Learner$help()
• mlr3::Learner$predict()
• mlr3::Learner$predict_newdata()
• mlr3::Learner$print()
• mlr3::Learner$train()
• mlr3cluster::LearnerClust$reset()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClustAgnes$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClustAgnes$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("cluster")) {
  learner = mlr3::lrn("clust.agnes")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}

mlr3cluster documentation built on March 31, 2023, 11:11 p.m.