AIRRSHIP - Adaptive Immune Receptor Repertoire Simulation of Human Immunoglobulin Production

AIRRSHIP simulates B cell receptor (BCR) sequences for use in benchmarking applications where BCR sequences of known origin are required.

AIRRSHIP replicates the VDJ recombination process from locus creation through to somatic hypermutation. Recombination metrics are derived from a range of experimental sequences allowing faithful replication of true repertoires. Users may also control a wide range of parameters that influence allele usage, junctional diversity and somatic hypermutation rates. The current model extends to human, heavy chain sequences only.

Overview

Algorithm

Above: AIRRSHIP simulates human heavy chain BCR sequences, closely replicating experimental data at each step of the synthetic recombination process. Key parameters such as VDJ usage, gene trimming, junctional insertions and somatic hypermutation can all be modified by the user. The FASTA output can then analysed using tools of interest and results easily compared to the tab separated values (TSV) file which acts as a record of the recombination process for each sequence.

Publications

An application note detailing the development and performance of AIRRSHIP is available at Bioinformatics.

If you make use of AIRRSHIP please cite:

Catherine Sutherland and Graeme J M Cowan, AIRRSHIP: simulating human B cell receptor repertoire sequences, Bioinformatics, Volume 39, Issue 6, June 2023, btad365, https://doi.org/10.1093/bioinformatics/btad365

Table of Contents

  1. Home
  2. Quickstart
  3. Simulation Model
    1. Haplotype creation
    2. VDJ recombination
    3. Trimming of gene ends
    4. Addition of NP nucleotides
    5. Somatic Hypermutation
  4. Commandline Usage
  5. Python
  6. Output Files
    1. Sequence FASTA
    2. Sequence information TSV
    3. Locus file
    4. Summary file
  7. Input Files
    1. IMGT alleles
    2. VDJ usage
    3. Trimming
    4. NP additions
    5. Somatic hypermutation
    6. Experimental references
  8. Non-human Species
  9. Release notes