mikessh commited on
Commit
f4efe2a
·
1 Parent(s): d22c8de

README: contents at a glance, provenance, and who consumes this pool

Browse files

Records what the deposit actually holds (15,018 metadata rows, 10,884 predicted +
369 native PDBs, 249 epitopes, 81 alleles) and which columns are measured versus
computed -- the pairings are VDJdb records, the coordinates and every confidence
metric are model output, and the derived angles track AlphaFold confidence rather
than being independent of it. Also names the downstream consumer: the TCRen2
receptor benchmark draws its real-binder positives from here.

Files changed (1) hide show
  1. README.md +35 -1
README.md CHANGED
@@ -29,4 +29,38 @@ Metadata for all structures is concatenated with corresponding VDJdb record meta
29
  * `ranking_confidence`, `plddt`, `ptm`, `iptm`, `tcr_pmhc_iptm` - TCRmodel2 quality metrics (for more information please visit [TCRmodel2 webpage](https://tcrmodel.ibbr.umd.edu/help)).
30
  * `scanning_angle` and `pitch_angle` - scanning and pitch TCR:pMHC structure angles calculated with STCRpy.
31
  * `is_native` - whether the structure is experimentally acquired (from PDB) or predicted.
32
- * `tcr_pmhc_hash` - unique TCR:pMHC record hash for matching predicted structure PDBs.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
  * `ranking_confidence`, `plddt`, `ptm`, `iptm`, `tcr_pmhc_iptm` - TCRmodel2 quality metrics (for more information please visit [TCRmodel2 webpage](https://tcrmodel.ibbr.umd.edu/help)).
30
  * `scanning_angle` and `pitch_angle` - scanning and pitch TCR:pMHC structure angles calculated with STCRpy.
31
  * `is_native` - whether the structure is experimentally acquired (from PDB) or predicted.
32
+ * `tcr_pmhc_hash` - unique TCR:pMHC record hash for matching predicted structure PDBs.
33
+
34
+ ## Contents at a glance
35
+
36
+ | | |
37
+ |---|---|
38
+ | metadata rows | 15,018 (11,234 distinct `tcr_pmhc_hash`) |
39
+ | predicted / native rows | 14,612 / 406 |
40
+ | PDB files shipped | 10,884 predicted (`pdb_files.tgz`) + 369 native (`pdb_files_native.tgz`) |
41
+ | epitopes / MHC alleles | 249 / 81 |
42
+ | MHC class | 14,915 MHC-I, 103 MHC-II |
43
+ | species | 14,928 human, 90 mouse |
44
+
45
+ A metadata row without a matching PDB is normal — the file set is the subset that modelled and passed
46
+ QC. Join on `tcr_pmhc_hash`; predicted filenames are `aligned_aligned_<hash>.pdb`, natives are
47
+ `aligned_<pdbid>.pdb`.
48
+
49
+ ## Provenance
50
+
51
+ - **TCR:epitope pairings are EXPERIMENTAL** — VDJdb records, carried through with the full VDJdb
52
+ "full table" columns (`reference.id`, `method.*`, `meta.*`, `vdjdb.score`).
53
+ - **Predicted structures are COMPUTED** (TCRmodel2/AlphaFold). `ranking_confidence`, `plddt`, `ptm`,
54
+ `iptm`, `tcr_pmhc_iptm` are the generator's own confidence metrics, not measurements.
55
+ - **Native structures are EXPERIMENTAL** (RCSB), re-processed into the same canonical frame.
56
+ - **Derived columns** (`num_contacts`, `scanning_angle`, `pitch_angle`) are computed from the
57
+ deposited coordinates — for predicted rows they inherit the model's error, and the angles in
58
+ particular track AlphaFold confidence rather than being independent of it.
59
+
60
+ ## Used by
61
+
62
+ The TCRen2 receptor-ranking benchmark (`isalgo/tcren_structures`) draws its **real-binder positives**
63
+ from this pool — filtered to `is_native == False`, restricted to hashes present in `pdb_files.tgz`,
64
+ and with TCRvdb pairs excluded — then matches them per epitope against the decoys in
65
+ `isalgo/tcren_structures::vdjdb_negatives/` and `::immrep23_negatives/`. See
66
+ `isalgo/tcren_structures::vdjdb_binder_benchmark/README.md`.