Skip to content

Reference

The reference documents the public immundata API. Start with read_repertoires() to ingest repertoire files, or ImmunData for the package's core data structure.

The API is organized around the lifecycle of an immune-repertoire dataset:

  • Ingestion reads raw repertoire files, manifests, and saved datasets.
  • Data model and aggregation defines receptors, repertoires, and strata.
  • Transformation filters, annotates, and modifies an ImmunData object.
  • Computation materializes or summarizes results when needed.

Use the navigation on the left or search at the top of the page to find a specific function.