Motivation

The SingleCellExperiment is quite a complex class that can hold multiple aspects of the same dataset. It is possible to have multiple assays, multiple dimensionality reduction results, and multiple alternative Experiments - each of which can further have multiple assays and reducedDims! In some scenarios, it may be desirable to loop over these pieces and apply the same function to each of them. This is made conveniently possible via the applySCE() framework.

Quick start

Let’s say we have a moderately complicated SingleCellExperiment object, containing multiple alternative Experiments for different data modalities.

library(SingleCellExperiment)
counts <- matrix(rpois(100, lambda = 10), ncol=10, nrow=10)
sce <- SingleCellExperiment(counts)

altExp(sce, "Spike") <- SingleCellExperiment(matrix(rpois(20, lambda = 5), ncol=10, nrow=2))
altExp(sce, "Protein") <- SingleCellExperiment(matrix(rpois(50, lambda = 100), ncol=10, nrow=5))
altExp(sce, "CRISPR") <- SingleCellExperiment(matrix(rbinom(80, p=0.1, 1), ncol=10, nrow=8))

sce

## class: SingleCellExperiment 
## dim: 10 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(3): Spike Protein CRISPR

Assume that we want to compute the total count for each modality, using the first assay. We might define a function that looks like the below. (We will come back to the purpose of multiplier= and subset.row= later.)

totalCount <- function(x, i=1, multiplier=1, subset.row=NULL) {
    mat <- assay(x, i)
    if (!is.null(subset.row)) {
        mat <- mat[subset.row,,drop=FALSE]
    }
    colSums(mat) * multiplier
}

We can then easily apply this function across the main and alternative Experiments with:

totals <- applySCE(sce, FUN=totalCount)
totals

## [[1]]
##  [1]  93 103 114  97  96 117 106  99 109 116
## 
## $Spike
##  [1]  9  7 15  7 10  8 16 14  9  9
## 
## $Protein
##  [1] 527 484 456 465 534 491 519 522 502 490
## 
## $CRISPR
##  [1] 1 2 1 1 1 0 1 1 1 1

Design explanation

The applySCE() call above is functionally equivalent to:

totals.manual <- list( 
    totalCount(sce),
    Spike=totalCount(altExp(sce, "Spike")),
    Protein=totalCount(altExp(sce, "Protein")),
    CRISPR=totalCount(altExp(sce, "CRISPR"))
)
stopifnot(identical(totals, totals.manual))

Besides being more verbose than applySCE(), this approach does not deal well with common arguments. Say we wanted to set multiplier=10 for all calls. With the manual approach above, this would involve specifying the argument multiple times:

totals10.manual <- list( 
    totalCount(sce, multiplier=10),
    Spike=totalCount(altExp(sce, "Spike"), multiplier=10),
    Protein=totalCount(altExp(sce, "Protein"), multiplier=10),
    CRISPR=totalCount(altExp(sce, "CRISPR"), multiplier=10)
)

Whereas with the applySCE() approach, we can just set it once. This makes it easier to change and reduces the possibility of errors when copy-pasting parameter lists across calls.

totals10.apply <- applySCE(sce, FUN=totalCount, multiplier=10)
stopifnot(identical(totals10.apply, totals10.manual))

Now, one might consider just using lapply() in this case, which also avoids the need for repeated specification:

totals10.lapply <- lapply(c(List(sce), altExps(sce)),
    FUN=totalCount, multiplier=10)
stopifnot(identical(totals10.apply, totals10.lapply))

However, this runs into the opposite problem - it is no longer possible to specify custom arguments for each call. For example, say we wanted to subset to a different set of features for each main and alternative Experiment. With applySCE(), this is still possible:

totals.custom <- applySCE(sce, FUN=totalCount, multiplier=10, 
    ALT.ARGS=list(Spike=list(subset.row=2), Protein=list(subset.row=3:5)))
totals.custom

## [[1]]
##  [1]  930 1030 1140  970  960 1170 1060  990 1090 1160
## 
## $Spike
##  [1]  40  60 130  30  30  30  90  80  40  50
## 
## $Protein
##  [1] 3130 2930 2800 2780 2900 3110 3230 3180 3080 2720
## 
## $CRISPR
##  [1] 10 20 10 10 10  0 10 10 10 10

In cases where we have a mix between custom and common arguments, applySCE() provides a more convenient and flexible interface than manual calls or lapply()ing.

Simplifying to a SingleCellExperiment

The other convenient aspect of applySCE() is that, if the specified FUN= returns a SingleCellExperiment, applySCE() will try to format the output as a SingleCellExperiment. To demonstrate, let’s use the head() function to take the first few features for each main and alternative Experiment:

head.sce <- applySCE(sce, FUN=head, n=5)
head.sce

## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(3): Spike Protein CRISPR

Rather than returning a list of SingleCellExperiments, we can see that the output is neatly organized as a SingleCellExperiment with the specified n=5 features. Moreover, each of the alternative Experiments is also truncated to its first 5 features (or fewer, if there weren’t that many to begin with). This output mirrors, as much as possible, the format of the input sce, and is much more convenient to work with than a list of objects.

altExp(head.sce)

## class: SingleCellExperiment 
## dim: 2 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):

altExp(head.sce, "Protein")

## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):

altExp(head.sce, "CRISPR")

## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):

To look under the hood, we can turn off simplification and see what happens. We see that the function indeed returns a list of SingleCellExperiment objects corresponding to the head() of each Experiment. When SIMPLIFY=TRUE, this list is passed through simplifyToSCE() to attempt the reorganization into a single object.

head.sce.list <- applySCE(sce, FUN=head, n=5, SIMPLIFY=FALSE) 
head.sce.list

## [[1]]
## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(3): Spike Protein CRISPR
## 
## $Spike
## class: SingleCellExperiment 
## dim: 2 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):
## 
## $Protein
## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):
## 
## $CRISPR
## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(0):

For comparison, if we had to do this manually, it would be rather tedious and error-prone, e.g., if we forgot to set n= or if we re-assigned the output of head() to the wrong alternative Experiment.

manual.head <- head(sce, n=5)
altExp(manual.head, "Spike") <- head(altExp(sce, "Spike"), n=5)
altExp(manual.head, "Protein") <- head(altExp(sce, "Protein"), n=5)
altExp(manual.head, "CRISPR") <- head(altExp(sce, "CRISPR"), n=5)
manual.head

## class: SingleCellExperiment 
## dim: 5 10 
## metadata(0):
## assays(1): ''
## rownames: NULL
## rowData names(0):
## colnames: NULL
## colData names(0):
## reducedDimNames(0):
## mainExpName: NULL
## altExpNames(3): Spike Protein CRISPR

Of course, this simplification is only possible when circumstances permit. It requires that FUN= returns a SingleCellExperiment at each call, and that no more than one result is generated for each alternative Experiment. Failure to meet these conditions will result in a warning and a non-simplified output.

Developers may prefer to set SIMPLIFY=FALSE and manually call simplifyToSCE(), possibly with warn.level=3 to trigger an explicit error when simplification fails.