getDistMtr: Obtain distance matrix

In kueckelj/confuns: Convenience Functions

Obtain distance matrix

Description

Extracts distance matrix from S4 object.

Usage

getDistMtr(object, ...)

## S4 method for signature 'Clustering'
getDistMtr(object, method_dist = "euclidean", stop_if_null = FALSE)

## S4 method for signature 'Analysis'
getDistMtr(object, method_dist = "euclidean", stop_if_null = FALSE)

## S4 method for signature 'ClusteringHclust'
getDistMtr(object, method_dist = "euclidean", stop_if_null = FALSE)

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

A distance matrix or NULL (if none has been computed yet).

kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.