Obtain grouping information — getGroupingDf • cypro

These functions let you extract a data.frame that contain variables with which cells are grouped.

getGroupingDf(object, phase = NULL, verbose = NULL)

getClusterDf(object, phase = NULL, verbose = NULL)

getMetaDf(object, phase = NULL)

getWellPlateDf(object)

Arguments

object

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.
verbose	Logical. If set to TRUE informative messages regarding the computational progress will be printed. (Warning messages will always be printed.)

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.

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

Value

A data.frame that contains the cell ids and their group belonging.