Skip to contents

Run scATAC quality control metrics

Source: R/RunATACQC.R
RunATACQC.Rd

Calculate common scATAC QC metrics and optionally filter cells by thresholds.

Usage

RunATACQC(
  object,
  assay = NULL,
  tss.positions = NULL,
  blacklist = NULL,
  fast = TRUE,
  min_pct_reads_in_peaks = NULL,
  min_TSS_enrichment = NULL,
  max_nucleosome_signal = NULL,
  max_blacklist_ratio = NULL,
  verbose = TRUE,
  srt = NULL
)

Arguments

object

A Seurat object.

assay

Assay to use. NULL uses the default assay.

tss.positions

TSS positions passed to Signac::TSSEnrichment.

blacklist

A GRanges blacklist used to compute blacklist_ratio.

fast

Whether to use the fast mode in Signac::TSSEnrichment.

min_pct_reads_in_peaks, min_TSS_enrichment, max_nucleosome_signal, max_blacklist_ratio

Optional thresholds used for filtering cells.

verbose

Whether to print the message. Default is TRUE.

srt

Deprecated alias for object; supply exactly one of the two. It will be removed in scop 1.0.0.

Value

A Seurat object with QC metadata added.

Examples

# \donttest{
data("pbmcmultiome_sub", package = "scop")
pbmcmultiome_sub <- RunATACQC(
  pbmcmultiome_sub,
  assay = "peaks",
  fast = TRUE
)
#> ℹ [2026-10-11 23:03:41] Calculating ATAC QC metrics...
#> ! [2026-10-11 23:03:41] Skip nucleosome signal: "No fragment files present in assay"
#> ! [2026-10-11 23:03:41] Skip FRiP calculation: no total fragment count column or local fragments available
#> ✔ [2026-10-11 23:03:41] ATAC QC completed
# }