getTracks: Obtain track data.frame.

In kueckelj/celltracer: An Analysis-Toolbox for High-Throughput Cell Imaging Data

Description

Obtain track data.frame.

Usage

getTracks(
  object,
  with_meta = TRUE,
  with_cluster = TRUE,
  phase = "all",
  phase_cluster = "first_tmt",
  verbose = TRUE
)

Arguments

object	A valid cell tracer object.
with_meta	Logical. If set to TRUE the discrete variables of the meta data slot are added to the output data.frame.
with_cluster	Logical. If set to TRUE the discrete variables of the meta data slot are added to the output data.frame.
phase	Character value. Refers to the phase of the experiment. Valid inputs are: 'before_tmt' Uses the data that refers to the time before the treatment. 'first_tmt' Uses the data that refers tot the time after the treatment. 'entire' Uses the complete data of the entire timespan. Note: This argument is ignored if the experiment set up did not include any treatment or the treatment started right from the beginning.
phase_cluster	Character value. Refers to the phase of the experiment from which to take the clustering variables. Valid inputs are: 'before_tmt' Uses the data that refers to the time before the treatment. 'first_tmt' Uses the data that refers tot the time after the treatment. Note: This argument is ignored if the experiment set up did not include any treatment or the treatment started right from the beginning.
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.

kueckelj/celltracer documentation built on June 2, 2021, 6:37 a.m.