ds.hclust: Conducts hierarchical clustering of a given dissimilarity...

In FlorianSchw/dsClusterAnalysisClient: DataSHIELD client side functions for the dsClusterAnalysisClient package

Conducts hierarchical clustering of a given dissimilarity structure

Description

This function is similar to the native R function 'hclust' from stats

Usage

ds.hclust(diss = NULL, method = "ward.D2", newobj = NULL, datasources = NULL)

Arguments

diss	is a string character of the dissimilarity structure
method	specifies the method for the calculation of the hierarchical clustering and can be either 'ward.D', 'ward.D2', 'single', 'complete', 'average', 'mcquitty', 'median' or 'centroid'
newobj	is the name of the new object which is created with this function
datasources	a list of DSConnection-class objects obtained after login

Details

The function calls the server-side function hclustDS that computes the hierarchical clustering of a dissimilarity structure (type 'dist'). The dissimilarity structure can be computed via the ds.dist function. The function creates a new object on the server-side, which is of class 'hclust'. The new object is named by the user using the newobj argument, otherwise it is named hclust.newobj by default.

Value

the object specified by the newobj argument of ds.hclust or default name hclust.newobj

Author(s)

Florian Schwarz for the German Institute of Human Nutrition

FlorianSchw/dsClusterAnalysisClient documentation built on Feb. 8, 2025, 10:32 a.m.