getStats: Obtain stat data.frame

Description Usage Arguments Value

View source: R/get-family.R

Description

Obtain stat data.frame

Usage

1
2
3
getStats(object, with_meta = TRUE, with_cluster = TRUE, phase = "first_tmt")

getStatsDf(object, with_meta = TRUE, with_cluster = TRUE, phase = "first_tmt")

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.

Value

A data.frame with all numeric variables summarizing the measurements of the track data.frame.


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