R/data.R

#' @name BuettnerFlorian 
#' @title test dataset for SIMLR 
#' @description example dataset to test SIMLR from the work by Buettner, Florian, et al. 
#' @docType data 
#' @usage data(BuettnerFlorian) 
#' @format gene expression measurements of individual cells 
#' @source Buettner, Florian, et al. "Computational analysis of cell-to-cell heterogeneity in single-cell RNA-sequencing data reveals hidden subpopulations of cells." Nature biotechnology 33.2 (2015): 155-160. 
#' @return list of 6: 
#'		in_X = input dataset as an (m x n) gene expression measurements of individual cells, 
#'  	n_clust = number of clusters (number of distinct true labels), 
#'  	true_labs = ground true of cluster assignments for each of the n_clust clusters, 
#'  	seed = seed used to compute the results for the example, 
#'  	results = result by SIMLR for the inputs defined as described, 
#'  	nmi = normalized mutual information as a measure of the inferred clusters compared to the true labels 
NULL

#' @name ZeiselAmit 
#' @title test dataset for SIMLR large scale 
#' @description example dataset to test SIMLR large scale. This is a reduced version of the dataset from the work by Zeisel, Amit, et al. 
#' @docType data 
#' @usage data(ZeiselAmit) 
#' @format gene expression measurements of individual cells 
#' @source Zeisel, Amit, et al. "Cell types in the mouse cortex and hippocampus revealed by single-cell RNA-seq." Science 347.6226 (2015): 1138-1142. 
#' @return list of 6: 
#'		in_X = input dataset as an (m x n) gene expression measurements of individual cells, 
#'  	n_clust = number of clusters (number of distinct true labels), 
#'  	true_labs = ground true of cluster assignments for each of the n_clust clusters, 
#'  	seed = seed used to compute the results for the example, 
#'  	results = result by SIMLR for the inputs defined as described, 
#'  	nmi = normalized mutual information as a measure of the inferred clusters compared to the true labels 
NULL

Try the SIMLR package in your browser

Any scripts or data that you put into this service are public.

SIMLR documentation built on Nov. 8, 2020, 5:40 p.m.