distanceHeat: Sample-to-sample heatmap

In DiscreteGapStatistic: An Extension of the Gap Statistic for Ordinal/Categorical Data

Sample-to-sample heatmap

Description

sample-to-sample heatmap clustering samples according to a given categorical distance Exploratory tool that helps to visualize/cluster blocks of observations across columns ordered according to given categorical distance. The final output is a clustered distance matrix. This plot is aimed to guide the 'DiscreteClusGap' user to give an idea which type of categorical distance would accommodate better to the inputted data. 'sample2sampleHeat' is based on the 'pheatmap' function from the 'pheatmap' R package. Thus, any parameter found in pheatmap can be specified to 'sample2sampleHeat'.

Usage

distanceHeat(
  x,
  distName,
  clustering_method = "complete",
  border_color = NA,
  ...
)

Arguments

x	matrix object or data.frame
distName	Name of categorical distance to apply.
clustering_method	string; clustering method used by pheatmap
border_color	string; color cell borders. By default, border_color = NA, where no border colors are shown.
...	other valid arguments in pheatmap function Available distances: 'bhattacharyya', 'chisquare', 'cramerV', 'hamming' and 'hellinger'.

Value

clustered heatmap

DiscreteGapStatistic documentation built on April 3, 2025, 9:22 p.m.