getHclust: Obtain object of class 'hclust'

In kueckelj/confuns: Convenience Functions

Obtain object of class hclust

Description

Extracts object of class hclust as described in stats::hclust().

Usage

getHclust(object, ...)

## S4 method for signature 'Clustering'
getHclust(object, method_dist = "euclidean", method_aggl = "ward.D")

## S4 method for signature 'Analysis'
getHclust(
  object,
  method_dist = "eucldidean",
  method_aggl = "ward.D",
  stop_if_null = TRUE
)

## S4 method for signature 'ClusteringHclust'
getHclust(
  object,
  method_dist = "euclidean",
  method_aggl = "ward.D",
  stop_if_null = TRUE
)

Arguments

object	Any object for whose class a method has been defined.
stop_if_null	Logical value. If TRUE and the function does not find the object to extract an informative error is raised. Else the empty value - usually NULL - is returned.

Value

An object of class hclust.

kueckelj/confuns documentation built on June 28, 2024, 9:19 a.m.