Skip to main content

Metaclonotype discovery pipeline

Project description

Metaclonotypist

Metaclonotypist is a flexible, modular pipeline for the discovery of TCR metaclones. It is powered by the pyrepseq package for repertoire sequencing analysis.

Features

  • Automated identification of T cell metaclones from repertoire sequencing data
  • HLA-association analysis with statistical testing
  • Modular, reproducible pipeline that combines speed with accuracy

Requirements

  • Python 3.8 or later
  • Install dependencies via pip (see pyproject.toml)

Installation

pip install metaclonotypist

Note that installation might take a couple of minutes, if dependencies need to be installed.

Usage

Basic run on example data

To run the CLI with example data:

git clone https://github.com/qimmuno/metaclonotypist.git
cd metaclonotypist
pip install -e .
bash examples/run_cli_example.sh

Outputs

This will create (if successful) the following outputs in the folder examples/out:

  • a volcano plot of cluster-HLA associations
  • a table of significant cluster-HLA associations
  • a corresponding table reporting the TCRs associated with all identified metaclones
  • a table of summary statistics and parameter values

The example data is small in size so the analysis should run in <10s. The analysis is based on a dataset (in examples/data) of the 30 top-most expanded clones at the site of a tuberculin-skin test from 150 individuals with associated HLA metadata.

Run on custom data

To run on your own dataset:

metaclonotypist --tcrpath path/to/tcr.csv --hlapath path/to/hla.csv --output-dir my_results/

Refer to examples/data/ for input file format.

Citing Metaclonotypist

Please cite our preprint.

BibTex

@article{turner_tst_2025,
	title = {Evolution of {T} cell responses in the tuberculin skin test reveals generalisable Mtb-reactive {T} cell metaclones},
	doi = {10.1101/2025.04.12.648537},
	journal = {biorXiv preprint},
	author = {Turner, Carolin T and Tiffeau-Mayer, Andreas and Rosenheim, Joshua and Chandran, Aneesh and Saxena, Rishika and Zhang, Ping and Jiang, Jana and Berkeley, Michelle and Pang, Flora and Uddin, Imran and Nageswaran, Gayathri and Byrne, Suzanne and Karthikeyan, Akshay and Smidt, Werner and Ogongo, Paul and Byng-Maddick, Rachel and Capocci, Santino and Lipman, Marc and Kunst, Heike and Lozewicz, Stefan and Rasmussen, Veron and Pollara, Gabriele and Knight, Julian C and Leslie, Alasdair and Chain, Benny M and Noursadeghi, Mahdad},
	year = {2025},
}

License

Metaclonotypist is released under the MIT License.

Contributing

Contributions, bug reports, and feature requests are welcome! Please open an issue or pull request on GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metaclonotypist-0.2.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metaclonotypist-0.2.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file metaclonotypist-0.2.0.tar.gz.

File metadata

  • Download URL: metaclonotypist-0.2.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for metaclonotypist-0.2.0.tar.gz
Algorithm Hash digest
SHA256 40de052f9b79d4c099059be020dd4df30b4f9076d0bd9157c6e812d90c4fd1b2
MD5 cb52b4827e48b8cc5afa90da1eb7b675
BLAKE2b-256 7b7a50541c20b70192b2d39ca0fd30f52c2059bd31af19c512229497c617ec88

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaclonotypist-0.2.0.tar.gz:

Publisher: release.yml on qimmuno/metaclonotypist

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file metaclonotypist-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for metaclonotypist-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb1c640083d5063382789178bfb2ead2b6c4d0a69d3d328459e110d97f68c83b
MD5 688eeb454376b98644b83125af052485
BLAKE2b-256 69354f55d3c9c0c7d26ce0bc7f33ed86739ce846260812fff5051349992c6b19

See more details on using hashes here.

Provenance

The following attestation bundles were made for metaclonotypist-0.2.0-py3-none-any.whl:

Publisher: release.yml on qimmuno/metaclonotypist

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page