10XGenomics / bamtofastq

Convert 10x BAM files to the original FASTQs compatible with 10x pipelines
MIT License
59 stars 6 forks source link

bamtofastq depends on bxindex, which is part of Long Ranger #99

Open slowkow opened 2 years ago

slowkow commented 2 years ago

I ran bamtofastq --bx-list=mylist.txt my.bam and got this error message:

https://github.com/10XGenomics/bamtofastq/blob/f914d80de23c78219a1fccd34e8f7864c2094406/src/bx_index.rs#L29

I was scratching my head wondering "What is bxindex?" and searching Google without finding any results.

Then I found: https://github.com/10XGenomics/longranger/blob/master/bin/bxindex

Now I understand that there is another project called Long Ranger that includes a Python library called tenkit that includes functions for creating a .bam.bxi file.

Would you consider including links to such dependencies for bamtofastq in the README file?

Also, I wonder if you might consider changing the error message about sorting and indexing? It could be more helpful if it included a link to the Long Ranger project, so folks can eventually figure out how to index their BAM files the way bamtofastq wants them.