Obtain stat data.frame

getStatsDf(
  object,
  phase = NULL,
  with_grouping = NULL,
  with_cluster = NULL,
  with_meta = NULL,
  with_well_plate = NULL,
  drop_na = TRUE,
  verbose = 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.

with_cluster, with_meta, with_well_plate

Logical values. Denoting if the respective grouping information should be joined to the stats data.frame or not.

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 with all numeric variables summarizing the measurements of the track data.frame.