DualFeatGate: Perform dual-feature gating on a Seurat object

In eisascience/scCustFx: single-cell custom fxs Package

Perform dual-feature gating on a Seurat object

Description

Perform dual-feature gating on a Seurat object

Usage

DualFeatGate(
  SerObj,
  feat1 = NULL,
  feat2 = NULL,
  thr1 = 0,
  thr2 = 0,
  dir1 = "pos",
  dir2 = "pos",
  cols = c("maroon", "gray", "blue", "forestgreen"),
  plotDimplot = T,
  returnSerObj = T,
  reduction = "umap",
  label = F,
  label.size = 6,
  repel = T,
  raster = F
)

Arguments

SerObj	A Seurat object to perform gating on.
feat1	A character string representing the name of the first feature to gate on. Defaults to NULL.
feat2	A character string representing the name of the second feature to gate on. Defaults to NULL.
thr1	A numeric threshold value for the first feature. Defaults to 0.
thr2	A numeric threshold value for the second feature. Defaults to 0.
dir1	A character string representing the direction of the threshold for the first feature, either "pos" or "neg". Defaults to "pos".
dir2	A character string representing the direction of the threshold for the second feature, either "pos" or "neg". Defaults to "pos".
plotDimplot	A logical value indicating whether to plot the result using Seurat's DimPlot function. Defaults to TRUE.
returnSerObj	A logical value indicating whether to return the modified Seurat object or just the gated cell names. Defaults to TRUE.

Value

A Seurat object with the compGate metadata column added if returnSerObj is TRUE, otherwise a character vector of gated cell names.

eisascience/scCustFx documentation built on June 2, 2025, 3:59 a.m.