classifyAbundanceProfiles: Classification of clustering results based on the abundance...

View source: R/stats.R

classifyAbundanceProfilesR Documentation

Classification of clustering results based on the abundance profiles

Description

Classifies clusters based on their abundance profiles (number of cells for each cluster).

Usage

classifyAbundanceProfiles(Results, method = "hierarchical_h",
  method.parameter = NULL, use.percentages = FALSE)

Arguments

Results

a 'Results' object

method

a character specifying the clustering method among: "hierarchical_h", "hierarchical_k","k-means","eigencell","clique"

method.parameter

a numeric specifying the numeric value required by the selected method

use.percentages

a logical specifying if cell cluster abudances must be expressed as percentages

Details

The classification is done on cell abundances of each clusters and could be performed using 5 methods:

  • "hierarchical_k" This method first compute the Pearson correlation matrix and then use this matrix to performs a hierarchical classification. The hierarchical classification is cut in order to return the desired number of classes. This number of classes must be provided as a numeric integer using the 'method.parameter' parameter. It is to note that negative correlations are considered as uncorrelated

  • "hierarchical_h" (default method) This method works in the same way than 'hierarchical_k' but the height where the hierarchical tree is specified. This height is a correlation threshold (a numeric double between 0 and 1 included, default is 0.7) provided using the 'method.parameter' parameter.

  • "kmeans" This method works as described in the R stats documentation (?kmeans) using the 'method.parameter' parameter to specify the desired number of classes.

  • "eigencell" This method performs an eigen vector decomposition and then calculate the correlations between cluster values and these vectors. Clusters which correlate above a specific threshold with the same eigen vector are classified together. This correlation threshold (a numeric double between 0 and 1 included, default is 0.8) provided using the 'method.parameter' parameter.

  • "clique" This method first computes the Pearson correlation matrix and then use this matrix to generate an undirected graph. In this graph, an edge is drawn between two nodes if the correlation coefficient in the adjacency matrix is above a specific threshold. This correlation threshold (a numeric double between 0 and 1 included, default is 0.7) provided using the 'method.parameter' parameter. After building the graph, the method looking for the largest cliques which are considered as classes of nodes. Cliques correspond to subgraph in which every two distinct vertices are adjacent.

Value

a S4 object of class 'AP'


tchitchek-lab/SPADEVizR documentation built on Jan. 27, 2024, 8:58 p.m.