pirl-unc / tcrsift / 25926219165
84%

DEFAULT BRANCH: main
Ran
Jobs 4
Files 29
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 76.859% (+0.6%) from 76.211%
25926219165

push

github

web-flow 
Fix #83: surface antigen/MHC/category metadata on match output (#87)

* Fix #83: surface antigen/MHC/category metadata on match output

Three concrete extensions to the existing annotation column set. Most
columns from #83's ask were already shipped by #54 (db_epitope,
db_protein, db_protein_canonical, db_species, db_mhc, db_category,
db_database, is_viral); this PR closes the remaining gaps.

1. **``db_host_species``** — the TCR donor's species, distinct from
   ``db_species`` (which is the antigen source organism). VDJdb's
   full export carries it but the loader was deliberately dropping it
   (see ``_normalize_vdjdb_paired`` / ``_long``). Now preserved as
   ``host_species`` on the standardized DB and surfaced as
   ``db_host_species`` on matches.

2. **Cross-species match strength** — ``db_match_strength`` gains
   ``ab_cross`` / ``b_only_cross`` variants when matched rows carry a
   non-human host species (anything other than "Homo sapiens" or
   "human"). Downstream filters can distinguish a confident
   human-vs-human match from a cross-species match where the
   sequence-level hit is real but the antigen specificity may not
   carry over.

3. **Contradictory category detection** — when a clone matches
   multiple DB rows that disagree on an informative ``db_category``
   value, ``db_category`` is set to ``"contradictory"`` rather than
   silently picking the mode. New ``CATEGORY_CONTRADICTORY``
   constant. ``unknown`` is excluded from the disagreement check —
   mixing a real label with ``unknown`` picks the real one.

The category bucket set (``viral``, ``bacterial``, ``self``,
``tumor_self``, ``other``, ``unknown``, ``contradictory``) covers
all of the issue's MART-1 / viral / self / contradictory / other /
unmatched asks: tumor_self subsumes MART-1 (via the curated
TUMOR_SELF_ANTIGEN_PATTERNS list including MART1, NY-ESO-1, MAGE,
WT1, TERT, etc.); "unmatched" maps to ``db_match=False`` with
``db_category=None``.

Tests added (9 new in tes... (continued)

6264 of 8150 relevant lines covered (76.86%)

3.07 hits per line

Coverage Regressions

Lines Coverage ∆ File
240
70.81
 1.52% til_select.py
28
89.59
 0.48% filter.py
23
94.64
 -0.55% annotate.py
21
94.81
 -0.46% clonotype.py
Jobs
ID Job ID Ran Files Coverage
1 python-3.9 - 25926219165.1 29
76.82
 GitHub Action Run
2 python-3.11 - 25926219165.2 29
76.85
 GitHub Action Run
3 python-3.10 - 25926219165.3 29
76.85
 GitHub Action Run
4 python-3.12 - 25926219165.4 29
76.85
 GitHub Action Run
Source Files on build 25926219165