This function returns the names of the groups in which a specific grouping variable groups the cells. Useful to obtain input options for arguments like across_subset.

getGroups(object, option)

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

Arguments

object

A valid cypro object.

grouping_variable

Character value. Denotes the discrete variable - the grouping of cells - of interest. Use getGroupingVariableNames() to obtain all valid input options.

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

Character vector of group names.