mockSCE {scuttle} | R Documentation

## Mock up a SingleCellExperiment

### Description

Mock up a SingleCellExperiment containing simulated data, for use in documentation examples.

### Usage

    mockSCE(ncells = 200, ngenes = 2000, nspikes = 100)

### Arguments

`ncells` | Integer scalar, number of cells to simulate.
`ngenes` | Integer scalar, number of genes to simulate.
`nspikes` | Integer scalar, number of spike-in transcripts to simulate.

### Details

Users should set a seed to obtain reproducible results from this function.

### Value

A SingleCellExperiment object containing a count matrix in the `"counts"` assay, a set of simulated `colData` fields, and spike-in data in the `"Spikes"` field of `altExps`.

### Author(s)

Aaron Lun

### See Also

`SingleCellExperiment`, for the constructor.

### Examples

    set.seed(1000)
    sce <- mockSCE()
    sce

[Package scuttle version 1.2.1 Index]