kersplatSimulate: Kersplat simulation

In Oshlack/splatter: Simple Simulation of Single-cell RNA Sequencing Data

Kersplat simulation

Description

Simulate scRNA-seq count data using the Kersplat model

Usage

kersplatSimulate(
  params = newKersplatParams(),
  sparsify = TRUE,
  verbose = TRUE,
  ...
)

Arguments

params	KersplatParams object containing simulation parameters.
sparsify	logical. Whether to automatically convert assays to sparse matrices if there will be a size reduction.
verbose	logical. Whether to print progress messages
...	any additional parameter settings to override what is provided in params.

Details

This functions is for simulating data in a single step. It consists of a call to kersplatSetup followed by a call to kersplatSample. Please see the documentation for those functions for more details of the individual steps.

Value

SingleCellExperiment containing simulated counts and intermediate values

See Also

kersplatSetup, kersplatSample

Examples

if (requireNamespace("igraph", quietly = TRUE)) {
    sim <- kersplatSimulate
}

Oshlack/splatter documentation built on Dec. 10, 2024, 3:48 p.m.