nf-core / nf-core/pathogensurveillance
README enhancements
Open
Nobody has claimed this yet.
- Dominant language
- Nextflow
- Stars
- 61
- Forks
- 8
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 1
Description
### Tasks
- [ ] A more simplified introduction section called just "Introduction" .
- [ ] A bioinformatics-focused introduction for researchers, something like "Introduction for researchers/bioinformaticians".
- [ ] An in-depth tutorial with more explanation and in the context of a biological question.
- [ ] An example report made from the tutorial dataset
- [ ] Explanation of output format (report, output directory)
- [ ] How to run Sequera Platform (which includes how to set up Google cloud, Azure, **AWS**, etc)
- [ ] A list of all analyses done by the pipeline
- [ ] Benchmarking/Performance section with example profiles
- [ ] link to change log
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 with the README and the tutorial dataset, then review how Sequera Platform and cloud setup are currently documented. Done means the checklist is covered with an introduction for general users, a bioinformatics-focused introduction, an explained biological tutorial, an example report, output and platform instructions, analysis and benchmarking sections, and a changelog link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, azure, gcp
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100