plotVelocityLineplot: Plot cell activity over time

Description Usage Arguments

View source: R/plot-family.R

Description

Visualizes the percentage of active cells over time.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
plotVelocityLineplot(
  object,
  across = "cl_condition",
  across_subset = NULL,
  phase = "all",
  phase_cluster = "first_tmt",
  threshold = NULL,
  smooth = TRUE,
  smooth_span = 0.25,
  smooth_se = FALSE,
  clrp = "milo",
  verbose = TRUE,
  in_shiny = FALSE
)

Arguments

object

A valid cell tracer object.

across

Character value. Denotes the discrete variable in the data.frame across which the variables of interest are to be analyzed or displayed. Valid input options can be obtained via getAcrossOptions().

across_subset

Character vector. The groups of interest that the across- variable contains. Valid input options can be obtained via getVariableValues().

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.

threshold

Numeric value or NULL. If set to NULL (the default) the threshold to consider a cell 'active' is equal to base::mean(speed) + base::sd(speed)

smooth

Logical. If set to TRUE the values are smoothed.

smooth_span

NUmeric value. Denotes the smoothing span used.

smooth_se

Logical. If set to TRUE the standard error will be displayed.

clrp

Character value. The color panel to be used. Valid input options can be obtained via allColorpanels().

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)


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