ExecuteSNF.CC: Execute the combined SNF (Similarity Network Fusion) and...

In taoshengxu/CancerSubtypes: Cancer subtypes identification, validation and visualization based on multiple genomic data sets

Description

This function is a combined process of SNF and Consensus Clustering for cancer subtypes identification. First it applied SNF to get the fusion patients similarity matrix. Then use this fusion patients similarity matrix as the sample distance for Consensus Clustering.

Usage

ExecuteSNF.CC(
  datasets,
  clusterNum,
  K = 20,
  alpha = 0.5,
  t = 20,
  maxK = 10,
  pItem = 0.8,
  reps = 500,
  title = "ConsensusClusterResult",
  plot = "png",
  finalLinkage = "average"
)

Arguments

datasets	A list containing data matrices. For each data matrix, the rows represent genomic features, and the columns represent samples. Same as ExecuteSNF
clusterNum	A integer representing the return cluster number. Same as ExecuteSNF
K	Number of nearest neighbors. Same as ExecuteSNF
alpha	Variance for local model. Same as ExecuteSNF
t	Number of iterations for the diffusion process. Same as ExecuteSNF
maxK	integer value. maximum cluster number for Consensus Clustering Algorithm to evaluate. Same as ExecuteCC.
pItem	Same as ExecuteCC
reps	integer value. number of subsamples(in other words, The iteration number of each cluster number). Same as ExecuteCC
title	character value for output directory. This title can be an absolute or relative path. Same as ExecuteCC
plot	Same as ExecuteCC
finalLinkage	Same as ExecuteCC

Value

Same as the ExecuteCC(). A list with the following elements.

• group : A vector represent the group of cancer subtypes. The order is corresponding to the the samples in the data matrix.
  

  This is the most important result for all clustering methods, so we place it as the first component. The format of group is consistent across different algorithms and therefore makes it convenient for downstream analyses. Moreover, the format of group is also compatible with the K-means result and the hclust (after using the cutree() function).

• distanceMatrix : It is a sample similarity matrix. The more large value between samples in the matrix, the more similarity the samples are.

  We extracted this matrix from the algorithmic procedure because it is useful for similarity analysis among the samples based on the clustering results.

• originalResult : The clustering result of the original function "ConsensusClusterPlus()"

  Different clustering algorithms have different output formats. Although we have the group component which has consistent format for all of the algorithms (making it easy for downstream analyses), we still keep the output from the original algorithms.

See Also

ExecuteSNF ExecuteCC

Examples

data(GeneExp)
data(miRNAExp)
GBM=list(GeneExp,miRNAExp)
result=ExecuteSNF.CC(GBM, clusterNum=3, K=20, alpha=0.5, t=20,
                    maxK = 5, pItem = 0.8,reps=500, 
                    title = "GBM", plot = "png", 
                    finalLinkage ="average")
result$group

taoshengxu/CancerSubtypes documentation built on Dec. 23, 2021, 7:46 a.m.