Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion to improve user manual #219

Open
TrentBrick opened this issue Nov 7, 2018 · 0 comments
Open

Suggestion to improve user manual #219

TrentBrick opened this issue Nov 7, 2018 · 0 comments

Comments

@TrentBrick
Copy link

In the manual under the bowtie2-inspect section, you should make it clear that when indexing files bowtie creates 6 different files, for example: lambda_virus.1.bt2 lambda_virus.2.bt2 lambda_virus.3.bt2 lambda_virus.4.bt2 lambda_virus.rev.1.bt2 lambda_virus.rev.2.bt2. And that the 'base name' means to just enter in 'lambda_virus'.

I am new to bowtie and have spent an hour trying to bowtie2-inspect some existing index files I was given and kept trying to specify one and only one of the index files rather than their 'base'.

I have now seen that in the bowtie-build section you state that 6 index files are generated but maybe even pointing readers of the bowtie-inspect section to this would help? This was the only section of the guide that I skipped ahead of and it clearly left me very lost as a result.

This is just a suggestion, sorry if this should not be in the issues section of the github repo. And thanks for creating bowtie2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant