getVariableValues: Obtain variable overview

Description Usage Arguments Value

Description

If the variable denoted in variable_name is categorical (character or factor) all unique values/levels are returned. If the variable is numeric it is given to psych::describe() which returns a statistical summary.

Usage

1
getVariableValues(object, phase = "first_tmt", variable_name)

Arguments

object

A valid cell tracer object.

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.

Note: This argument is ignored if the experiment set up did not include any treatment or the treatment started right from the beginning.

variable_name

Character value. Denotes the variable of interest. Valid inputs can be obtained via the function getVariableNames().

Value

A character vector or a data.frame of one row containing basic descriptive statistics.


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