scClust: scClust

Description Usage Arguments Value

View source: R/scClust.R


performs clustering on single-cell RNA-seq data.


scClust(mat, nCs, method = "simlr", similarity = "pearson",
  geneFilter = 0.8, seed = 1, ...)



a (m x n) data matrix of gene expression measurements of individual cells with rows representing genes and columns representing cells.


number of clusters to be estimated


Clustering method to be performed on the dataset between "'simlr'" implemented version of SIMLR or "'kmeans'" from amap package. It is set to "'simlr'" by default.


A similarity metric to be used for clustering. This must be one of "'euclidean'", "'pearson'" or "'spearman'". If 'kmeans' is chosen for method, "'manhattan'" and "'maximum'" distances are also available.


A threshold to remove genes. The genes that are not expressed more than the threshold across all the cells in the dataset will be removed. Genes will not be removed if set to 0.


an additional parameters for corresponding clustering method specified from 'method'


For SIMLR, list of 8 elements describing the clusters obtained by SIMLR, of which y are the resulting clusters: 'y“ = results of k-means clusterings, 'S' = similarities computed by SIMLR, 'F' = results from network diffiusion, 'ydata' = data referring the the results by k-means, 'alphaK' = clustering coefficients, 'execution.time“ = execution time of the present run, 'converge' = iterative convergence values by T-SNE, 'LF' = parameters of the clustering

For Kmeans, a list with components: 'cluster' = A vector of integers indicating the cluster to which each point is allocated 'centers' = A matrix of cluster centres 'withinss' = The within-cluster sum of squares distance for each cluster 'size' = The number of points in each cluster

SydneyBioX/scdney documentation built on Aug. 22, 2019, 10:55 a.m.