Rename cluster/group names

Allows to rename groups within a discrete grouping variable (such as cluster variables) of the feature data in slot @fdata as well as in slot @dea where differential gene expression analysis results are stored. Use renameSegments() to rename already drawn segments.

renameGroups(
  object,
  grouping_variable,
  ...,
  keep_levels = NULL,
  of_sample = NA
)

renameSegments(object, ..., of_sample = NA)

Arguments

object

A valid spata-object.

grouping_variable

Character value. The grouping variable of interest.

...

The groups to be renamed specified according to the following syntax: 'new_group_name' = 'old_group_name'.

of_sample

This argument is currently inactive. It might be reactivated when spata-objects can store more than one sample.

Value

An updated spata-object.

Examples

#Not run:

 object <-
    renameGroups(object = spata_object,
                 grouping_variable = "seurat_clusters",
                 "first_new_group" = "1",
                 "sec_new_group" = "2")