sanger-tol / variantcalling

This Nextflow DSL2 pipeline calls variants on long read alignment. It is run after sanger-tol/readmapping in the Sanger ToL production suite but with options to run on unaligned reads.
https://pipelines.tol.sanger.ac.uk/variantcalling
MIT License
3 stars 0 forks source link

Documentation part 1 #24

Closed priyanka-surana closed 2 years ago

priyanka-surana commented 2 years ago

This starts the documentation by modifying README.md, docs/README.md, docs/usage.md and docs/parameters.md. It also creates the file docs/results.md

Documentation tries to replicate pipeline pages on nf-core website. Example: https://nf-co.re/rnaseq

PR checklist

muffato commented 2 years ago

Looks good to me. Just one thing: you've stated that this PR creates docs/results.md and it's indeed empty. I guess that's because we don't have the actual variant-calling sub-workflows yet, so we don't know what outputs will be and where ?

priyanka-surana commented 2 years ago

Yes both output.md and results.md will be filled in as we go along with more subworkflows, this PR creates the necessary structure.