LabelClusters: Label clusters on a ggplot2-based scatter plot

View source: R/visualization.R

LabelClustersR Documentation

Label clusters on a ggplot2-based scatter plot

Description

Label clusters on a ggplot2-based scatter plot

Usage

LabelClusters(
  plot,
  id,
  clusters = NULL,
  labels = NULL,
  split.by = NULL,
  repel = TRUE,
  box = FALSE,
  geom = "GeomPoint",
  position = "median",
  ...
)

Arguments

plot

A ggplot2-based scatter plot

id

Name of variable used for coloring scatter plot

clusters

Vector of cluster ids to label

labels

Custom labels for the clusters

split.by

Split labels by some grouping label, useful when using facet_wrap or facet_grid

repel

Use geom_text_repel to create nicely-repelled labels

box

Use geom_label/geom_label_repel (includes a box around the text labels)

geom

Name of geom to get X/Y aesthetic names for

position

How to place the label if repel = FALSE. If "median", place the label at the median position. If "nearest" place the label at the position of the nearest data point to the median.

...

Extra parameters to geom_text_repel, such as size

Value

A ggplot2-based scatter plot with cluster labels

See Also

geom_text_repel geom_text

Examples

data("pbmc_small")
plot <- DimPlot(object = pbmc_small)
LabelClusters(plot = plot, id = 'ident')


satijalab/seurat documentation built on May 11, 2024, 4:04 a.m.