Documentation

The keywords “MUST”, “MUST NOT”, “SHOULD”, etc. are to be interpreted as described in RFC 2119.

Code comment of channel structure

Each input and output channel SHOULD have a comment that describes the output structure of the channel. For example:

input:
ch_reads // channel: [mandatory] meta, reads
val_sort // boolean: [mandatory] false
<...>
 
emit:
bam = SAMTOOLS_VIEW.out.bam // channel: [ val(meta), path(bam) ]
versions = ch_versions      // channel: [ path(versions.yml) ]

Meta.yml documentation of channel structure

Each input and output channel structure SHOULD also be described in the meta.yml file’s description entry.

description: |
  Structure: [ val(meta), path(tsv)]
  (Sub)contig coverage table