rename_strata: Rename strata labels

View source: R/operations_agg_strata.R

rename_strataR Documentation

Rename strata labels

Description

Renames strata_name values for existing strata (imd_strata_id) in idata$repertoires.

This function updates only repertoire-level metadata; annotations remain unchanged and keep only imd_strata_id.

Usage

rename_strata(
  idata,
  names,
  unnamed = c("error", "auto", "keep"),
  auto_prefix = "Strata"
)

Arguments

idata

An ImmunData object with strata already created by agg_strata().

names

Mapping from imd_strata_id to strata_name. Supported forms:

  • named character vector, where names are strata IDs;

  • data frame with columns imd_strata_id and strata_name.

unnamed

What to do with strata IDs not covered by names: "error" (default), "auto", or "keep".

auto_prefix

Prefix used when unnamed = "auto" (or when legacy objects miss strata_name). Default: "Strata".

Value

A new ImmunData object with updated strata_name in ⁠$repertoires⁠.

See Also

agg_strata(), agg_repertoires()


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