plotVelocityHeatmap: Plot cell velocity over time

Description Usage Arguments

View source: R/plot-family.R

Description

Uses the design of a heatmap to visualize the velocity dynamics over time across a variable of interest.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
plotVelocityHeatmap(
  object,
  across = "cl_condition",
  across_subset = NULL,
  phase = "all",
  phase_cluster = "first_tmt",
  n_cells = 100,
  color = viridis::viridis(15),
  smooth = TRUE,
  smooth_span = 0.25,
  arrange_rows = "maxima",
  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.

n_cells

Numeric calue. Determines the number of cells that are randomly chosen from every group to be displayed. Useful to keep plots insightful and aesthetically pleasing.

color

The colorspectrum to be used.

smooth

Logical. If set to TRUE the values are smoothed.

smooth_span

NUmeric value. Denotes the smoothing span used.

arrange_rows

Character value. Either 'maxima' or 'none'.

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.