plotPamSilWidth: Plot Cluster Quality

Description Usage Arguments Value

View source: R/plot-family.R

Description

Visualizes the cluster quality via the average silhouette Width.

Usage

1
2
3
4
5
6
7
plotPamSilWidth(
  object,
  k,
  phase = "first_tmt",
  clrp = "milo",
  display_average = TRUE
)

Arguments

object

A valid cell tracer object.

k

NUmeric value. The k-value used to calculate the pam-cluster.

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.

clrp

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

display_average

Logical. If set to TRUE the average across all clusters is displayed via a horizontal, dashed line.

Value

A ggplot.


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