print.ImmunData: Display the contents and biological definitions of ImmunData

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

Display the contents and biological definitions of ImmunData

Description

Use print() to inspect the receptor table, chain annotations, and biological schemas stored in an ImmunData object.

Use this method for a quick overview after reading, filtering, or aggregating repertoire data. It displays the units available in the object: receptors, chain rows, repertoires, and strata. It also shows the feature and chain definitions used to construct receptors.

Printing is read-only. It does not collect the complete dataset into R and does not change the original object. The object is returned invisibly so it can still be assigned or used in a pipeline.

Usage

## S3 method for class 'ImmunData'
print(x, ...)

Arguments

x	An ImmunData object to display.
...	Additional arguments. Currently not used.

Details

A section is shown only when that information is available. An object without repertoire definitions, for example, has no repertoire schema or repertoire summary section. Duckplyr prints a preview of large tables rather than every row.

Value

x, invisibly. The displayed output is a human-readable overview; no data are modified.

See Also

ImmunData, dplyr::collect(), dplyr::count()

Examples

library(immundata)

options(immundata.verbose = FALSE)
idata <- get_test_idata()

print(idata)
# Expected output contains these sections:
#   ImmunData
#   Receptors
#   Annotations
#   Receptor schema
#   Repertoire schema
#   List of repertoires

# `Receptors` previews distinct biological receptor definitions.
# `Annotations` previews the retained chain rows and sample information.
# The schema sections explain how receptors and repertoires were defined.

immundata documentation built on Aug. 26, 2026, 5:08 p.m.