RHGCPlotParameter: Visualizing the Parameter Records during Clustering

In XuegongLab/HGC: A fast hierarchical graph-based clustering method

Description

The function visualizes the parameter output from HGC.parameter.

Usage

HGC.PlotParameter(record, parameter)

Arguments

record	the input record matrix of parameters from HGC.parameter.
parameter	a string with alternatives "CL" or "ANN". Choose "CL" to plot the chain lengths and "ANN" to plot the average neighbor number.

Details

The chain length(CL) and average neighbor number(ANN) are key factors related with the time complexity of clustering by HGC. The function provides the visualization of them.

Value

The function will return 1 if the dendrogram is successfully drawn.

Examples

data(Pollen)
Pollen.PCs <- Pollen[["PCs"]]
Pollen.SNN <- SNN.Construction(Pollen.PCs)
Pollen.ParameterRecord <- HGC.parameter(G = Pollen.SNN)
HGC.PlotParameter(Pollen.ParameterRecord, parameter = "CL")
HGC.PlotParameter(Pollen.ParameterRecord, parameter = "ANN")

XuegongLab/HGC documentation built on Dec. 18, 2021, 7:23 p.m.