CNVKit Tutorial / Improved Documentation / Track issues with CNVkit
Nobody has claimed this yet.
- Dominant language
- Nextflow
- Stars
- 603
- Forks
- 548
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 1
Description
Description of feature
cc @lescai
We receive many questions on how to run CNVkit and correctly configure the parameters and using custom configurations. We should add a tutorial/guide on how to make use the various options.
Multiple Issues
There are many issues described with CNVkit that we will collect as subissues here and tackle in the coming releases (either by documentation improvements or code changes).
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 reviewing the existing CNVkit guidance and the questions collected around running CNVkit, parameter configuration, and custom configurations. Identify the subissues to be covered, then define the tutorial's scope and verify that it addresses those usage questions and tracks the remaining documentation or code work.
Written by the indexing model from the issue text.
Assessment
- Domain
- bioinformatics, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100