Obtain track data.frame.

Source: R/get-family.R

Obtain track data.frame.

getTracksDf(
  object,
  phase = NULL,
  with_grouping = NULL,
  with_cluster = NULL,
  with_meta = NULL,
  with_well_plate = NULL,
  drop_na = NULL,
  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

Logical. If set to TRUE the discrete variables of the meta data slot are added to the output data.frame.
with_meta

Logical. If set to TRUE the discrete variables of the meta data slot are added to the output data.frame.
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 in which each observation refers to a cell at a given frame.