Improve documentation on the effects of completeness/contamination filters
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Nextflow
- Stars
- 321
- Forks
- 156
- Avg merge
- 12h 59m
- Merged PRs (30d)
- 5
Description
Description of feature
Seems to be tripping people up is that they don't have GTDB results for some of their bins
https://nfcore.slack.com/archives/CE6SDBX2A/p1708189315383339?thread_ts=1707403870.961809&cid=CE6SDBX2A
https://nfcore.slack.com/archives/CE9MS66BS/p1710942695546379?thread_ts=1710942636.651329&cid=CE9MS66BS
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the issue description and both linked Slack threads to identify what users misunderstand about completeness and contamination filters. Update the relevant documentation to explain the filters' effects and why some bins may lack GTDB results, then verify that the documented behavior addresses the reported confusion.
Written by the indexing model from the issue text.
Assessment
- Domain
- bioinformatics, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100