clusterPlotDS: Plots hierarchical cluster

In FlorianSchw/dsClusterAnalysis: DataSHIELD server side functions for the dsClusterAnalysis package

Plots hierarchical cluster

Description

This function is similar to the R function 'fviz_dend' from the factoextra package

Usage

clusterPlotDS(
  tree,
  k,
  h,
  k_colors,
  palette,
  show_labels = FALSE,
  color_labels_by_k
)

Arguments

tree	is a string character of the data set
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. If both, k and h, are given, k overrides h.
k_colors	is a vector containing colors to be used for groups
palette	is a vector containing colors
show_labels	is a logical whether labels are shown in the plot. Always set to FALSE in the server side function
color_labels_by_k	is a logical value which colors the branches by group when k is not NULL

Details

The function computes the dendrogram without any labels to prevent any disclosures. The new object is named by the user using the newobj argument, otherwise it is named kmeans.newobj by default.

Value

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

Author(s)

Florian Schwarz for the German Institute of Human Nutrition

FlorianSchw/dsClusterAnalysis documentation built on Feb. 8, 2025, 10:31 a.m.