splitModule {celda} | R Documentation

## Split celda feature module

### Description

Manually select a celda feature module to split into 2 or more modules. Useful for splitting up modules that show divergent expression of features in multiple cell clusters.

### Usage

    splitModule(x, ...)

    ## S4 method for signature 'SingleCellExperiment'
    splitModule(
      x,
      useAssay = "counts",
      altExpName = "featureSubset",
      module,
      n = 2,
      seed = 12345
    )

### Arguments

`x` | A SingleCellExperiment object with the matrix located in the assay slot under `useAssay`. Rows represent features and columns represent cells.
`...` | Ignored. Placeholder to prevent check warning.
`useAssay` | A string specifying which assay slot to use for `x`. Default "counts".
`altExpName` | The name for the altExp slot to use. Default "featureSubset".
`module` | Integer. The module to be split.
`n` | Integer. How many modules should `module` be split into. Default 2.
`seed` | Integer. Passed to with_seed. For reproducibility, a default value of 12345 is used. If NULL, no calls to with_seed are made.

### Value

A updated SingleCellExperiment object with new feature modules stored in column `celda_feature_module` in `rowData(x)`.

### Examples

    data(sceCeldaCG)
    # Split module 5 into 2 new modules.
    sce <- splitModule(sceCeldaCG, module = 5)

[Package celda version 1.6.1 Index]