kmayerb / tcrdist3

flexible CDR based distance metrics
MIT License
53 stars 17 forks source link

Distances without cdr3_a_nucseq and cdr3_b_nucseq #61

Closed andreas-wilm closed 2 years ago

andreas-wilm commented 2 years ago

Hi Koshlan,

According to the documentation on input requirements, one or more of the following columns are required and are case-sensitive:

    ‘v_a_gene’, ‘v_b_gene’, ‘v_g_gene’, or ‘v_d_gene’
    ‘j_a_gene’, ‘j_b_gene’, ‘j_g_gene’, or ‘j_d_gene’
    ‘cdr3_a_aa’, ‘cdr3_b_aa’, ‘cdr3_g_aa’, or ‘cdr3a_d_aa’
    ‘cdr3_a_nucseq’, ‘cdr3_b_nucseq, ‘cdr3_g_nucseq’, or ‘cdr3a_d_nucseq’

However, I've used TCRdist3 to compute distances on dataframes without cdr3_a_nucseq and cdr3_b_nucseq, which seems to have worked fine, but am now wondering whether it did the right thing.

Apologies for the paranoid question, Andreas

kmayerb commented 2 years ago
Tcrdist3 only requires 3 input columns for single chain analysis (i.e., for beta chain cdr3_b_aa and v_b_gene, j_b_gene) and 6 columns for paired chain analysis (i.e., cdr3_b_aa, v_b_gene, j_b_gene, cdr3_a_aa, v_a_gene, and j_a_gene). More columns can be included depending on the application.
andreas-wilm commented 2 years ago

Thank you. That makes sense. It might be useful to add this to https://tcrdist3.readthedocs.io/en/latest/inputs.html which currently lists the nucseqs as requirement (under "One or more of the following columns are required and are case-sensitive"). Best

kmayerb commented 2 years ago

Done. Thanks.

On Thu, Nov 4, 2021 at 7:29 PM Andreas Wilm @.***> wrote:

Thank you. That makes sense. It might be useful to add this to https://tcrdist3.readthedocs.io/en/latest/inputs.html which currently lists the nucseqs as requirement. Best

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/kmayerb/tcrdist3/issues/61#issuecomment-961579495, or unsubscribe https://github.com/notifications/unsubscribe-auth/ALD2PVZQ2T6FJIUOLJXWC3DUKM6PTANCNFSM5HIL275Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.