issues
search
Clinical-Genomics-Lund
/
nextflow_wgs
5
stars
5
forks
source link
Write usage documentation
#99
Closed
Jakob37
closed
10 months ago
Jakob37
commented
11 months ago
First outline:
Introduction
Conceptual overview of the purpose of the pipeline
Conceptual introduction to the running modes
Running it
How to run it locally
Stub run
How to deploy it
Inputs
The samplesheet
Types of input data (i.e. FASTQ, BAM, VCF?)
Annotation files
Containers
Profiles
Briefly outline the conceptual intent of each
High-level outline of the processing steps
What software are executed along each path
What annotation files are needed
Software
A list of all included software with versions
Steps:
[ ] Write a rough draft
[ ] Write a preliminary first outline
[ ] Check for feedbacks
[ ] Look how it should be deployed. In a repo-yaml to build to read the docs?
[ ] Write the yaml
[ ] Make it deploy to readthedocs
First outline:
Steps: