make_seq_options: Build a 'seq_options' list for sequence‑based receptor...

In immundata: A Unified Data Layer for Large-Scale Single-Cell, Spatial and Bulk Immunomics

Build a seq_options list for sequence‑based receptor filtering

Description

A convenience wrapper that validates the common arguments for filter_receptors() and returns them in the required list form.

Usage

make_seq_options(
  query_col,
  patterns,
  method = c("exact", "lev", "hamm", "regex"),
  max_dist = NA,
  name_type = c("index", "pattern")
)

Arguments

query_col	Character(1). Name of the receptor column to compare (e.g. "cdr3_aa").
patterns	Character vector of sequences or regular expressions to search for.
method	One of "exact", "regex", "lev" (Levenshtein), or "hamm" (Hamming). Defaults to "exact".
max_dist	Numeric distance threshold for "lev" / "hamm" filtering. Use NA (default) to keep all rows after annotation.
name_type	Passed straight to annotate_tbl_distance(); either "index" (default) or "pattern".

Value

A named list suitable for the seq_options argument of filter_receptors().

See Also

filter_receptors(), annotate_receptors()

immundata documentation built on April 4, 2026, 9:09 a.m.