plotDistribution: Plot descriptive statistics

Description Usage Arguments Value

View source: R/plot-family.R

Description

These functions are deprecated in favor of plotDensityplot(), plotHistogram(), plotRidgplot(), plotBoxplot() and plotViolinplot().

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
plotDistribution(
  object,
  variables = "all",
  across = "cl_condition",
  across_subset = NULL,
  phase = "first_tmt",
  plot_type = "boxplot",
  binwidth = 1,
  display_points = FALSE,
  pt_size = 1.2,
  pt_alpha = 0.8,
  pt_color = "black",
  n_cells = 100,
  shape_to = NULL,
  test_pairwise = "none",
  test_groupwise = "none",
  ref_group,
  clrp = "milo",
  ...,
  pretty_names = TRUE,
  verbose = TRUE
)

Arguments

object

A valid cell tracer object.

variables
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.

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

plot_type

Character value. One of 'histogram', 'ridgeplot', 'boxplot', 'violinplot' or 'density' to visualize the value distribution of those variables specified via the variables argument.

If set to 'boxplot' or 'violinplot' and only one variable is specified statistical test can be performed.

binwidth

Numeric value. Only relevant if plot_type is set to 'histogram'.

display_points

Logical. If set to TRUE the value distribution of n_cells is additionally displayed by points.

pt_size

Numeric value. Denotes the size and alpha values of the points of the scatterplot.

pt_alpha

Numeric value. Denotes the size and alpha values of the points of the scatterplot.

pt_color

Character value. Denotes the color of the points of the scatterplot.

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.

shape_to

Character value. The variable that is to be displayed or highlighted by the dots shape.

test_pairwise

Character value. One of 'none', 't.test', 'wilcox.test'.

test_groupwise

Character value. One of 'none', 'anova', 'kruskal.test'.

ref_group

Character value. Denotes the reference group for the statistical tests. Must be one value of the variable specified in across.

clrp

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

...

Additional arguments given to ggplot2::facet_wrap().

pretty_names

Logical. If set to TRUE the function attempts to convert the concisely named variables into more aesthetically pleasing ones.

verbose

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

(Warning messages will always be printed.)

Value

A ggplot.


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