Update README.md #101
Update README.md #101
Conversation
Readme updated with the pipelines descriptions
This PR is against the
|
|
I changed the base to dev. We don't usually open PRs to master ;) |
matrulda
left a comment
matrulda
left a comment
There was a problem hiding this comment.
Thank you for contributing! I left some comments for you.
In addition to the comments, make sure to address the PR checklist
|
|
||
| <h1> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="docs/images/seqinspector_poster_2024_v4.png"> |
There was a problem hiding this comment.
Should this file be included in the PR? Anyhow, I think it would be better to use a picture of the tube map instead: #85
|
|
||
| **nf-core/seqinspector** is a bioinformatics pipeline that ... | ||
| **nf-core/seqinspector** - | ||
| <p align="justify"> <br>A basic QC pipeline for sequencing core facilities providing high quality data from a range of different sequencing instruments to their users is in the interest of every sequencing facility. In order to monitor their sequencing quality, performing standardized, yet flexible quality controls for every sequencing project and sample that passes through their facilities is crucial to ensure consistent quality and dependable results.</br> |
There was a problem hiding this comment.
This does not really comply with the TODO that the description should be very short:
<!-- TODO nf-core:
Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the
major pipeline sections and the types of output it produces. You're giving an overview to someone new
to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction
-->
Could you slim this down?
Also remove the TODO section below this when it is done
|
I will close this PR in favor of #104 |
3 participants
Readme updated with the pipelines descriptions
PR checklist
nf-core lint).nf-test test main.nf.test -profile test,docker).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).