ds.cutree: Cuts the tree of a hclust object

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

Cuts the tree of a hclust object

Description

This function is similar to the native R function from stats

Usage

ds.cutree(tree = NULL, k = NULL, h = NULL, newobj = NULL, datasources = NULL)

Arguments

tree	is a string character specifying the name of the hclust object
k	specifies the number of clusters in which the tree should be cut
h	specifies the height of a tree at which the tree should be cut
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 cutreeDS that computes the clusters for a given number of clusters k or height h, and assigns the new object to the server-side. The new object is named by the user using the newobj argument, otherwise it is named cutree.newobj by default.

Value

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

Author(s)

Florian Schwarz for the German Institute of Human Nutrition

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