.mockRefData {SingleR} | R Documentation

## Mock data for examples

### Description

Make up some test and reference data for the various examples in the SingleR package.

### Usage

    .mockRefData(ngroups = 5, nreps = 4, ngenes = 1000, prop = 0.5)

    .mockTestData(mock.ref, ncells = 100)

### Arguments

`ngroups` | Integer scalar specifying the number of groups.
`nreps` | Integer scalar specifying the number of replicates per group.
`ngenes` | Integer scalar specifying the number of genes in the dataset.
`prop` | Numeric scalar specifying the proportion of genes that are DE between groups.
`mock.ref` | A SummarizedExperiment object produced by `.mockRefData`.
`ncells` | Integer scalar specifying the number of cells to simulate.

### Details

This functions are simply provided to simulate some data in the Examples of the documentation. The simulations are very simple and should not be used for performance comparisons.

### Value

Both functions return a SummarizedExperiment object containing simulated counts in the `counts` assay, with the group assignment of each sample in the `"label"` field of the `colData`.

### Author(s)

Aaron Lun

### Examples

    ref <- .mockRefData()
    test <- .mockTestData(ref)

[Package SingleR version 1.2.4 Index]