klebgenomics / Kleborate

GNU General Public License v3.0
117 stars 49 forks source link

Kleborate Tutorial contains wrong description about incomplete matches #66

Open ealdraed opened 1 year ago

ealdraed commented 1 year ago

Hello,

I noticed that the KlebNet-GSP Kleborate Tutorial available under https://bit.ly/kleborate-workshop (btw: the link is not correctly set in the Kleborate README.md, i.e. missing https:// in front of the link) contains a wrong description at the top of page 10.

This part describes the reporting of acquired AMR genes and states:

If the hit is less than 100% coverage, a ? is added to the result. E.g. TEM-15? indicates an inexact match at 100% coverage, and TEM-15*? indicates an inexact match at <100% coverage.

I think it would be correct if it would state:

If the hit is less than 100% coverage, a ? is added to the result. E.g. TEM-15* indicates an inexact match at 100% coverage, and TEM-15*? indicates an inexact match at <100% coverage.

Note the asterisk instead of the question mark.

But I suppose the better formulation is the one provided in the wiki:

If the hit is less than 100% coverage, a ? is added to the result E.g. TEM-15? indicates an incomplete match at 100% identity, and TEM-15*? indicates an incomplete match at <100% identity.

Best regards