shawhahnlab / partis Goto Github PK

Partis is an HMM-based framework for B- and T-cell receptor sequence annotation, simulation, clonal family and germline inference, and affinity prediction. It is built on top of the ham HMM compiler and ig-sw set of Smith-Waterman annotation tools. Partis is free software under the GPL v3.

The various components are described in the following papers. Since they do quite different things, it's best if you can cite the specific paper(s) that describe the components that you're using.

• Paired clustering Ralph, DK, & Matsen IV, FA (2022). Inference of B cell clonal families using heavy/light chain pairing information. PLoS Computational Biology, 18(11), e1010723.
• Selection metrics Ralph, DK, & Matsen IV, FA (2020). Using B cell receptor lineage structures to predict affinity. PLoS Computational Biology, 16(11), e1008391.
• Germline inference Ralph, DK, & Matsen IV, FA (2019). Per-sample immunoglobulin germline inference [...]. PLoS Computational Biology, 15(7), e1007133.
• Clonal family inference Ralph, DK, & Matsen IV, FA (2016). Likelihood-based Inference of B-cell Clonal Families. PLoS Computational Biology, 12(10), e1005086.
• HMM framework and BCR annotation Ralph, DK, & Matsen IV, FA (2016). Consistency of [...] Enables Accurate B Cell Receptor Sequence Annotation. PLoS Computational Biology, 12(1), e1004409.

The best place to start reading the manual is either the quick start or table of contents. Details on the many options not documented there may be found by running each subcommand's help, for instance partis cache-parameters --help or partis simulate --help.

To ask questions about how to run or how things work, please use the google group. For specific issues with the software, e.g. bug reports or feature requests, on the other hand, submit an issue on github. You can also search through past discussion both on the google group and in closed issues. If you'd like to be notified when something important changes, please subscribe to the google group.