celdaClusters {celda} | R Documentation

## Get or set the cell cluster labels from a celda SingleCellExperiment object or celda model object.

### Description

Return or set the cell cluster labels determined by celda_C or celda_CG models.

### Usage

    celdaClusters(x, ...)

    ## S4 method for signature 'SingleCellExperiment'
    celdaClusters(x, altExpName = "featureSubset")

    ## S4 method for signature 'celdaModel'
    celdaClusters(x)

    celdaClusters(x, altExpName = "featureSubset") <- value

    ## S4 replacement method for signature 'SingleCellExperiment'
    celdaClusters(x, altExpName = "featureSubset") <- value

### Arguments

`x` | Can be one of A SingleCellExperiment object returned by celda_C, or celda_CG, with the matrix located in the `useAssay` assay slot. The a altExp slot with name `altExpName` will be used. Rows represent features and columns represent cells. Celda model object.
`...` | Ignored. Placeholder to prevent check warning.
`altExpName` | The name for the altExp slot to use. Default "featureSubset".
`value` | Character vector of cell cluster labels for replacements. Works only if `x` is a SingleCellExperiment object.

### Value

One of

- Character vector if `x` is a SingleCellExperiment object. Contains cell cluster labels for each cell in x.

- List if `x` is a celda model object. Contains cell cluster labels (for celda_C and celdaCG Models) and/or feature module labels (for celda_G and celdaCG Models).

### Examples

    data(sceCeldaCG)
    celdaClusters(sceCeldaCG)
    data(celdaCGMod)
    celdaClusters(celdaCGMod)

[Package celda version 1.6.1 Index]