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

[Documentation] Example tutorial walkthroughs and test data #192

Open
erfanshekarriz opened this issue Dec 22, 2023 · 0 comments
Open

[Documentation] Example tutorial walkthroughs and test data #192

erfanshekarriz opened this issue Dec 22, 2023 · 0 comments

Comments

@erfanshekarriz
Copy link

erfanshekarriz commented Dec 22, 2023

Hi and hope all is well!

I just wanted to jump in and leave a quick recommendation for documentation.

Specifically that I think CoverM lacks any real-life example walkthroughs with accessible data from reproducibility. I found this to be a problem when trying to run coverm contig on my dataset and running into heaps of errors until finally figuring out (3 whole days later) that my input fasta reference had two duplicate sequences.

I think in this case having a tutorial or walkthrough with a real dataset can give a sanity check to the user that most likely the problem is from their data and not a software bug, which I think would save up lots of your time as well as the users.

Hope this helps!

Best,
Erfan

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