Performs correlation analysis on the variables with which the correlation analysis has been initiated via initiateCorrelation().

correlateAll(
  object,
  variable_set,
  method_corr = NULL,
  phase = NULL,
  print_errors = FALSE,
  verbose = NULL
)

correlateAcross(
  object,
  variable_set,
  phase = NULL,
  across = NULL,
  method_corr = NULL,
  verbose = NULL,
  print_errors = TRUE
)

Arguments

object

A valid cypro object.

variable_set

Character value. Denotes the variable set of interest. Use getVariableSetNames() to obtain all names of currently stored variable sets in your object.

method_corr

Character value. Denotes the correlation method of interest. Either 'pearson' or 'spearman'.

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.)

across

Character vector or NULL. Specifies the grouping variables across which correlation is computed. Meaning that before correlation is computed the data is split into the groups suggested by the respective grouping variable.

If set to NULL defaults to all grouping variables obtained via getGroupingVariableNames().

Value

updated_object return

Details

correlateAcross() iterates over all grouping variables and computes the correlation analysis for every group the respective grouping variables suggests. Use the across-argument of plotCorrplot() to visualize the results of correlateAcross().