simulateCellscelda_G {celda} | R Documentation

## Simulate cells from the celda_G model

### Description

Generates a simulated counts matrix and feature module clusters according to the generative process of the celda_G model.

### Usage

    simulateCellscelda_G(
      model,
      C = 100,
      NRange = c(500, 1000),
      G = 100,
      L = 10,
      beta = 1,
      gamma = 5,
      delta = 1,
      seed = 12345,
      ...
    )

### Arguments

`model` | Character. Options available in 'celda::availableModels'.
`C` | Integer. Number of cells to simulate. Default 100.
`NRange` | Integer vector. A vector of length 2 that specifies the lower and upper bounds of the number of counts generated for each cell. Default c(500, 5000).
`G` | Integer. The total number of features to be simulated. Default 100.
`L` | Integer. Number of feature modules. Default 10.
`beta` | Numeric. Concentration parameter for Phi. Adds a pseudocount to each feature module in each cell. Default 1.
`gamma` | Numeric. Concentration parameter for Eta. Adds a pseudocount to the number of features in each module. Default 5.
`delta` | Numeric. Concentration parameter for Psi. Adds a pseudocount to each feature in each module. Default 1.
`seed` | Integer. Passed to with_seed. For reproducibility, a default value of 12345 is used. If NULL, no calls to with_seed are made.
`...` | Additional parameters.

### Value

List. Contains the simulated matrix 'counts', feature module clusters 'y', and input parameters.

### See Also

'celda_C()' for simulating cell subpopulations and 'celda_CG()' for simulating feature modules and cell populations.

### Examples

    celdaGSim <- simulateCells(model = "celda_G")

[Package celda version 1.2.4 Index]