Transfer reference labels to query cells — RunLabelTransfer • scop

Standalone label-transfer workflow for query cells using a reference object. The current implementation is optimized for scATAC query objects mapped to a scRNA-seq reference via gene activity.

Usage

RunLabelTransfer(
  srt,
  reference,
  assay = NULL,
  method = c("Seurat", "scOMM"),
  prefix = "ATAC",
  reference_assay = NULL,
  reference_reduction = "pca",
  reference_dims = 1:30,
  reference_label = NULL,
  add_gene_activity = TRUE,
  gene_activity_assay = "ACTIVITY",
  weight_reduction = NULL,
  dims = 2:30,
  features = NULL,
  prediction_prefix = "predicted_",
  k.weight = 100,
  evaluate = FALSE,
  truth_col = NULL,
  tool_name = NULL,
  rare_threshold = 0.05,
  scomm_python = NULL,
  scomm_hidden_nodes = c(128, 64),
  scomm_epochs = 10,
  scomm_batch_size = 32,
  scomm_threshold = 0.5,
  scomm_seed = 11,
  verbose = TRUE
)

Arguments

srt: A Seurat object.
reference: RNA reference Seurat object used for label transfer.
assay: Which assay to use. If NULL, the default assay of the Seurat object will be used. When the object also contains ChromatinAssay, the default assay and additional ChromatinAssay will be preprocessed sequentially.
method: Label-transfer backend. One of "Seurat" or "scOMM".
prefix: Prefix used to resolve ATAC reductions. Default is "ATAC".
reference_assay: Assay used in the reference object.
reference_reduction: Reduction used in the reference object.
reference_dims: Dimensions used from the reference reduction.
reference_label: Metadata column in the reference used as transfer labels.
add_gene_activity: Whether to calculate a gene activity assay for the query.
gene_activity_assay: Name of the gene activity assay used for mapping.
weight_reduction: Reduction in srt used to weight transferred labels. If NULL, an ATAC linear reduction is resolved automatically from ATAC_default_linear_reduction, {prefix}lsi, {prefix}svd, or the current default reduction.
dims: Query reduction dimensions used by TransferData.
features: Features used by FindTransferAnchors. If NULL, reference variable features are used.
prediction_prefix: Prefix added to prediction metadata columns.
k.weight: Number of neighbors used when weighting transfer anchors.
evaluate: Whether to compute mapping metrics against a truth label.
truth_col: Metadata column in srt used as the truth label when evaluate = TRUE.
tool_name: Name used to store detailed results in srt@tools.
rare_threshold: Maximum class proportion used to define rare classes when calculating rare_recall.
scomm_python: Optional Python binary used by the scOMM backend. If NULL, SCOP_SCOMM_PYTHON is consulted and reticulate defaults are used otherwise.
scomm_hidden_nodes, scomm_epochs, scomm_batch_size, scomm_threshold, scomm_seed: Parameters passed to the optional scOMM backend.
verbose: Whether to print the message. Default is TRUE.

Value

A Seurat object with prediction metadata added.