Description Usage Arguments Value
Takes ExpressionSet object and calculates the optimal number of kmeans, pam, or hierarchical clusters for the samples or genes using the gap statistic.
1 2 |
cellData |
ExpressionSet object created with readCells (and preferably transformed with prepCells). It is also helpful to first run reduceGenes_var and reduceGenes_pca. |
gene_clust |
Boolean specifying whether the gap statistic should be calculated for the samples or genes. TRUE calculates for the cells, FALSE for the genes. |
fun |
Character string specifying whether the gap statistic should be calculated for kmeans, pam, or hierarchical clustering. Possible values are kmeans, pam, or hclust. clustering methods to perform. All three can be specified, or a subset of the three. |
max_clust |
Integer specifying the maximum possible number of clusters in the dataset. Set higher than the expected value. matrix for 'hierarchical.' Equivalent to the 'method' parameter within the dist function. |
boot |
Integer specifying the number of bootstrap iterations to perform when calculating the gap statistic. 'hierarchical.' Equivalent to the 'method' parameter within the hclust function. |
plot |
Boolean specifying whether a plot of the gap values vs the number of clusters should be produced. |
save |
Boolean specifying whether the plot should be saved. |
print |
Boolean specifying whether the optimal number of clusters should be printed in the terminal window. |
The optimal number of clusters calculated from the gap statistic with the given parameters. A new column is added to pData indicating the optimal number of cell or gene clusters for the chosen clustering method.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.