#sequences #model #python #package #python-packages #generate #recombination

bin+lib righor

Righor creates model of Ig/TCR sequences from sequencing data

4 releases

0.2.3 Apr 30, 2024
0.2.2 Apr 21, 2024
0.2.1 Mar 28, 2024
0.2.0 Mar 28, 2024

#56 in Biology

Download history 310/week @ 2024-03-26 33/week @ 2024-04-02 165/week @ 2024-04-16 29/week @ 2024-04-23 144/week @ 2024-04-30

338 downloads per month

MIT license

6.5K SLoC


This package, based on IGoR, is meant to learn models of V(D)J recombination.

It can:

  • generate sequences
  • evaluate sequences (infer the most likely recombination scenarios)
  • compute "pgen"

It's probably easier to use the companion python package (pip install righor), but working in Rust directly should also be viable.

How to use the python package:

Load a model:

import righor
import matplotlib.pyplot as plt
import seaborn
import pandas as pd
from tqdm.notebook import tqdm
from collections import Counter
import numpy as np

igor_model = righor.load_model("human", "trb")

# alternatively, you can load a model from igor files
# igor_model = righor.load_model_from_files(params.txt, marginals.txt, anchor_v.csv, anchor_j.csv)

Generate sequences fast:

# Create a generator object
generator = igor_model.generator(seed=42) # or igor_model.generator() to run it without a seed

# Generate 10'000 functional sequences (not out-of-frame, no stop codons, right boundaries)
for _ in tqdm(range(10000)):
    # generate_without_errors ignore Igor error model, use "generate" if this is needed
    sequence = generator.generate_without_errors(functional=True)
    if "IGH" in sequence.cdr3_aa:
        print("TRB CDR3 containing \"IGH\":", sequence.cdr3_aa)

# Generate one sequence with a particular V/J genes family
V_genes = righor.genes_matching("TRBV5", igor_model) # return all the V genes that match TRBV5
J_genes = righor.genes_matching("TRBJ", igor_model) # all the J genes
generator = igor_model.generator(seed=42, available_v=V_genes, available_j=J_genes)
generation_result = generator.generate_without_errors(functional=True)
print("Explicit recombination event:")

Evaluate a given sequence:


# first align the sequence
align_params = righor.AlignmentParameters() # default alignment parameters
aligned_sequence = igor_model.align_sequence(my_sequence, align_params)

# we can also align a sequence from a CDR3 and a list of V-genes and J-genes (much faster)
# v_genes = righor.genes_matching("TRBV1", igor_model)
# j_genes = righor.genes_matching("TRBJ1", igor_model)

# then evaluate it
infer_params = righor.InferenceParameters() # default inference parameters
result_inference = igor_model.evaluate(aligned_sequence, infer_params)

# Most likely scenario
best_event = result_inference.best_event

print(f"Probability that this specific event chain created the sequence: {best_event.likelihood / result_inference.likelihood:.2f}.")
print(f"Reconstructed sequence (without errors):", best_event.reconstructed_sequence)
print(f"Pgen: {result_inference.pgen:.1e}")

Infer a model:

# here we just generate the sequences needed
generator = igor_model.generator()
example_seq = generator.generate(False)
sequences = [generator.generate(False).full_seq for _ in range(1000)]

# define parameters for the alignment and the inference
align_params = righor.AlignmentParameters()
align_params.left_v_cutoff = 40
infer_params = righor.InferenceParameters()

# generate an uniform model as a starting point
# (it's generally *much* faster to start from an already inferred model)
model = igor_model.copy()
model.p_ins_vd = np.ones(model.p_ins_vd.shape)
model.error_rate = 0

# align multiple sequences at once
aligned_sequences = model.align_all_sequences(sequences, align_params)

# multiple round of expectation-maximization to infer the model
models = {}
model = igor_model.uniform()
model.error_rate = 0
models[0] = model
for ii in tqdm(range(35)):
    models[ii+1] = models[ii].copy()
    models[ii+1].infer(aligned_sequences, infer_params)

Extra stuff:

Main differences with IGoR:

  • "dynamic programming" method, instead of summing over all events we first pre-compute over sum of events. This means that we can run it with undefined nucleotides like N (at least in theory, I need to add full support for these).
  • The D gene alignment is less constrained


  • Need to get rid of any primers/ends on the V gene side before running it
  • The reads need to be long enough to fully cover the CDR3 (even when it's particularly long)

Programming stuff:

  • There's a wasm version for web use.
  • python version is in a different crate now.
  • to add a model permanently, add it to "models.json". First model in a category is the default model. Each field is one independant model. The elements in chain and species should always be lower-case.

Current status:

  • speed is ok (50 seqs/s roughly ?). Could be slightly faster. I think some range should be replaced by iterator.
  • pgen works, but because I consider way more D gene alignment than Quentin some issue when endD and startD are really close to each other.


~481K SLoC