im_common_args: Common arguments for immunarch helpers

View source: R/aaa-registry.R

im_common_argsR Documentation

Common arguments for immunarch helpers

Description

Common arguments for immunarch helpers

Usage

im_common_args(
  autojoin = getOption("immundata.autojoin", TRUE),
  format = c("long", "wide")
)

Arguments

autojoin

Logical. If TRUE, join repertoire metadata by the schema repertoire id. Change the default behaviour by calling options(immunarch.autojoin = FALSE).

format

String. One of "long" ("long" tibble with imd_repertoire_id, facet columns, and value; useful for visualizations) or "wide" (wide/unmelted table of features, with each row corresponding to a specific repertoire / pair of repertoires; useful for Machine Learning).


immunarch documentation built on Nov. 5, 2025, 7:21 p.m.