Docs: mention the support of alignment.bam.bai only, not alignment.bai

genid / Yleaf

Yleaf software for human Y-chromosomal haplogroup inference from next generation sequencing data

GNU General Public License v3.0

23 stars 10 forks source link

Docs: mention the support of alignment.bam.bai only, not alignment.bai #9

Closed serge2016 closed 2 years ago

serge2016 commented 2 years ago

Hello!

Thank you for this great tool! I think it would be great to mention in the readme, that the index file for input BAM-file should be named as alignment.bam.bai, not alignment.bai. This restriction is due to this line: https://github.com/genid/Yleaf/blob/master/Yleaf.py#L434

And this is not obvious, because different tools process differently named indesxes.

bramvanwersch commented 2 years ago

Hey,

My apologies for the late reply. Thank you for your comment. This is indeed unclear. I added a very small update that allows the program to recognize both naming schemes. You can download the new update by pulling the latest commits.