Rename cluster variables

Implementations of the functions dplyr::rename() and dplyr::rename_with() that can be used to rename the variables of the cell cluster data.frame.

rename*Df() changes the names of individual variables using new_name = old_name syntax. rename*DfWith() renames variables with a function specified in argument .fn.

renameClusterDf(object, phase = NULL, ...)

renameClusterDfWith(object, phase = NULL, ...)

Arguments

object	A valid cypro object.
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.
...	Input for function dplyr::rename_with(). This includes the arguments .fn and .cols.

Value

An updated version of the input cypro-object.

Details

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

Note

Make sure not to rename protected variables. Use the function protectedVariables() to obtain variable names that must not be changed and must not be added. Doing so will result in erroneous analysis results as many functions rely on these variables to carry specific meaning.

See also

dplyr::rename(), dplyr::rename_with()