Update MakeDb documentation

immcantation / changeo

Changeo-O is part of the Immcantation analysis framework for Adaptive Immune Receptor Repertoire sequencing (AIRR-seq). Change-O provides tools for processing the output of V(D)J alignment tools, assigning clonal clusters, and reconstructing germline sequences.

https://changeo.readthedocs.io

GNU Affero General Public License v3.0

0 stars 0 forks source link

Update MakeDb documentation #60

Closed ssnn-airr closed 8 years ago

ssnn-airr commented 8 years ago

Original report by Jason Vander Heiden (Bitbucket: javh, GitHub: javh).

It's not documented why some records fail MakeDb. Currently, our criteria seem to be lack of V, J or junction sequence; ie, those records that IMGT failed to align. I think the criteria are fine, we just need to document it somewhere.

While we're at it, I think the list of required fields isn't accurate. JUNCTION_LENGTH and D_CALL are no longer needed, yes?

ssnn-airr commented 8 years ago

Original comment by Namita Gupta (Bitbucket: namita1025, GitHub: namita1025).

Added to MakeDb.py -h in 1a48aceb0417