PlotSickleJrUMAP: Generate UMAP plots for an object of class SickleJr

View source: R/jrSiCKLSNMF.R

PlotSickleJrUMAPR Documentation

Generate UMAP plots for an object of class SickleJr

Description

Plot the first and second dimensions of a UMAP dimension reduction and color either by clustering results or metadata.

Usage

PlotSickleJrUMAP(
  SickleJr,
  umap.modality = "H",
  cluster = "kmeans",
  title = "",
  colorbymetadata = NULL,
  legendname = NULL
)

Arguments

SickleJr

An object of class SickleJr

umap.modality

String corresponding to the name of the UMAP of interest: defaults to "H"

cluster

String input that indicates which cluster to color by: defaults to "kmeans"

title

String input for optional ggplot plot title

colorbymetadata

Name of metadata column if coloring by metadata

legendname

String input that to allow specification of a different legend name

Value

An object of class SickleJr with plots added to the plots slot

References

\insertRef

ggplot2jrSiCKLSNMF

Examples

SimSickleJrSmall<-PlotSickleJrUMAP(SimSickleJrSmall,
title="K-Means Example")
SimSickleJrSmall<-PlotSickleJrUMAP(SimSickleJrSmall,umap.modality=1)

jrSiCKLSNMF documentation built on Aug. 12, 2025, 1:08 a.m.