Allows to rename particular groups within a grouping variable of the cypro object's cell data.

renameGroups(object, grouping_variable = NULL, ..., phase = NULL)

Arguments

object

A valid cypro object.

grouping_variable

Character value. The name of the grouping variable whose groups you want to rename.

...

The groups to be renamed specified according to the following syntax: 'new_cluster_name' = 'old_cluster_name'.

phase

Character or numeric. If character, the ordinal value referring to the phase of interest (e.g. 'first', 'second' etc.). referring to the phase of interest or 'all'. If numeric, the number referring to the phase.

If set to NULL takes the phase denoted as default with adjustDefault().

Ignored if the experiment design contains only one phase.

Value

An updated version of the input cypro-object.

Details

Renaming groups of variables well_plate_name, well_plate_index, well and well_image is not allowed and will result in an error.

Use getGroupNames() to check if renaming resulted in the desired output.