knitr::opts_chunk$set(error=FALSE, warning=FALSE, message=FALSE)

Introduction

The r Biocpkg("scRNAseq") package provides convenient access to several publicly available data sets in the form of SingleCellExperiment objects. The focus of this package is to capture datasets that are not easily read into R with a one-liner from, e.g., read.csv(). Instead, we do the necessary data munging so that users only need to call a single function to obtain a well-formed SingleCellExperiment. For example:

library(scRNAseq)
fluidigm <- ReprocessedFluidigmData()
fluidigm

Readers are referred to the r Biocpkg("SummarizedExperiment") and r Biocpkg("SingleCellExperiment") documentation for further information on how to work with SingleCellExperiment objects.

Available data sets

The listDatasets() function returns all available datasets in r Biocpkg("scRNAseq"), along with some summary statistics and the necessary R command to load them.

out <- listDatasets()
out <- as.data.frame(out)
out$Taxonomy <- c(`10090`="Mouse", `9606`="Human", `8355`="Xenopus")[as.character(out$Taxonomy)]
out$Call <- sprintf("`%s`", out$Call)
knitr::kable(out)

If the original dataset was not provided with Ensembl annotation, we can map the identifiers with ensembl=TRUE. Any genes without a corresponding Ensembl identifier is discarded from the dataset.

sce <- ZeiselBrainData(ensembl=TRUE)
head(rownames(sce))

Functions also have a location=TRUE argument that loads in the gene coordinates.

sce <- ZeiselBrainData(ensembl=TRUE, location=TRUE)
head(rowRanges(sce))

Adding new data sets

Please contact us if you have a data set that you would like to see added to this package. The only requirement is that your data set has publicly available expression values (ideally counts) and sample annotation. The more difficult/custom the format, the better, as its inclusion in this package will provide more value for other users in the R/Bioconductor community.

If you have already written code that processes your desired data set in a SingleCellExperiment-like form, we would welcome a pull request here. The process can be expedited by ensuring that you have the following files:

Potential contributors are recommended to examine some of the existing scripts in the package to pick up the coding conventions. Remember, we're more likely to accept a contribution if it's indistinguishable from something we might have written ourselves!

References



drisso/scRNAseq documentation built on Feb. 16, 2021, 1:18 a.m.