diff --git a/.github/workflows/code-linting.yml b/.github/workflows/code-linting.yml index d15c4af6f12..89e55872174 100644 --- a/.github/workflows/code-linting.yml +++ b/.github/workflows/code-linting.yml @@ -12,7 +12,7 @@ jobs: steps: - uses: actions/checkout@v2 - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v2 with: node-version: "10" @@ -27,7 +27,7 @@ jobs: steps: - uses: actions/checkout@v2 - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v2 with: node-version: "10" @@ -44,7 +44,7 @@ jobs: uses: actions/checkout@v2 - name: Install NodeJS - uses: actions/setup-node@v1 + uses: actions/setup-node@v2 with: node-version: "10" diff --git a/.yamllint.yml b/.yamllint.yml new file mode 100644 index 00000000000..6889fa342e9 --- /dev/null +++ b/.yamllint.yml @@ -0,0 +1,5 @@ +extends: default + +rules: + document-start: disable + line-length: disable diff --git a/modules/bandage/image/meta.yml b/modules/bandage/image/meta.yml index 1c2b9840218..e0a1da1d086 100644 --- a/modules/bandage/image/meta.yml +++ b/modules/bandage/image/meta.yml @@ -7,38 +7,38 @@ keywords: - visualisation tools: - bandage: - description: | - Bandage - a Bioinformatics Application for Navigating De novo Assembly Graphs Easily - homepage: https://github.com/rrwick/Bandage - documentation: https://github.com/rrwick/Bandage - licence: ['GPL-3.0-or-later'] + description: | + Bandage - a Bioinformatics Application for Navigating De novo Assembly Graphs Easily + homepage: https://github.com/rrwick/Bandage + documentation: https://github.com/rrwick/Bandage + licence: ['GPL-3.0-or-later'] input: - meta: - type: map - description: | - Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] - gfa: - type: file - description: Assembly graph in GFA 1.0 format - pattern: "*.gfa" + type: file + description: Assembly graph in GFA 1.0 format + pattern: "*.gfa" output: - meta: - type: map - description: | - Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] - png: - type: file - description: Bandage image in PNG format - pattern: "*.png" + type: file + description: Bandage image in PNG format + pattern: "*.png" - svg: - type: file - description: Bandage image in SVG format - pattern: "*.svg" + type: file + description: Bandage image in SVG format + pattern: "*.svg" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@heuermh" diff --git a/modules/dedup/meta.yml b/modules/dedup/meta.yml index 0ddd648f356..cd98a514598 100644 --- a/modules/dedup/meta.yml +++ b/modules/dedup/meta.yml @@ -54,7 +54,5 @@ output: description: Dedup log information pattern: "*log" - - authors: - "@jfy133" diff --git a/modules/gatk4/createsequencedictionary/meta.yml b/modules/gatk4/createsequencedictionary/meta.yml index 54f479b393d..a37de1bc1b9 100644 --- a/modules/gatk4/createsequencedictionary/meta.yml +++ b/modules/gatk4/createsequencedictionary/meta.yml @@ -5,28 +5,28 @@ keywords: - fasta tools: - gatk: - description: | - Developed in the Data Sciences Platform at the Broad Institute, the toolkit offers a wide variety of tools - with a primary focus on variant discovery and genotyping. Its powerful processing engine - and high-performance computing features make it capable of taking on projects of any size. - homepage: https://gatk.broadinstitute.org/hc/en-us - documentation: https://gatk.broadinstitute.org/hc/en-us/categories/360002369672s - doi: 10.1158/1538-7445.AM2017-3590 - licence: ['Apache-2.0'] + description: | + Developed in the Data Sciences Platform at the Broad Institute, the toolkit offers a wide variety of tools + with a primary focus on variant discovery and genotyping. Its powerful processing engine + and high-performance computing features make it capable of taking on projects of any size. + homepage: https://gatk.broadinstitute.org/hc/en-us + documentation: https://gatk.broadinstitute.org/hc/en-us/categories/360002369672s + doi: 10.1158/1538-7445.AM2017-3590 + licence: ['Apache-2.0'] input: - fasta: - type: file - description: Input fasta file - pattern: "*.{fasta,fa}" + type: file + description: Input fasta file + pattern: "*.{fasta,fa}" output: - dict: - type: file - description: gatk dictionary file - pattern: "*.{dict}" + type: file + description: gatk dictionary file + pattern: "*.{dict}" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@maxulysse" diff --git a/modules/gatk4/mutect2/meta.yml b/modules/gatk4/mutect2/meta.yml index 83f6cb7c6ea..5a5b622a3b5 100644 --- a/modules/gatk4/mutect2/meta.yml +++ b/modules/gatk4/mutect2/meta.yml @@ -1,5 +1,5 @@ name: gatk4_mutect2 -description: Call somatic SNVs and indels via local assembly of haplotypes. +description: Call somatic SNVs and indels via local assembly of haplotypes. keywords: - gatk4 - mutect2 diff --git a/modules/gffread/meta.yml b/modules/gffread/meta.yml index bf1a15cbaa5..141bb5910e6 100644 --- a/modules/gffread/meta.yml +++ b/modules/gffread/meta.yml @@ -15,9 +15,9 @@ tools: input: - gff: - type: file - description: A reference file in either the GFF3, GFF2 or GTF format. - pattern: "*.{gff, gtf}" + type: file + description: A reference file in either the GFF3, GFF2 or GTF format. + pattern: "*.{gff, gtf}" output: - gtf: diff --git a/modules/gunzip/meta.yml b/modules/gunzip/meta.yml index ea1f15460fb..9d6a22665e4 100644 --- a/modules/gunzip/meta.yml +++ b/modules/gunzip/meta.yml @@ -5,29 +5,29 @@ keywords: - compression tools: - gunzip: - description: | - gzip is a file format and a software application used for file compression and decompression. - documentation: https://www.gnu.org/software/gzip/manual/gzip.html - licence: ['GPL-3.0-or-later'] + description: | + gzip is a file format and a software application used for file compression and decompression. + documentation: https://www.gnu.org/software/gzip/manual/gzip.html + licence: ['GPL-3.0-or-later'] input: - meta: - type: map - description: | - Optional groovy Map containing meta information - e.g. [ id:'test', single_end:false ] + type: map + description: | + Optional groovy Map containing meta information + e.g. [ id:'test', single_end:false ] - archive: - type: file - description: File to be compressed/uncompressed - pattern: "*.*" + type: file + description: File to be compressed/uncompressed + pattern: "*.*" output: - gunzip: - type: file - description: Compressed/uncompressed file - pattern: "*.*" + type: file + description: Compressed/uncompressed file + pattern: "*.*" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@joseespinosa" - "@drpatelh" diff --git a/modules/lissero/meta.yml b/modules/lissero/meta.yml index d4fb38df99e..15970d40835 100644 --- a/modules/lissero/meta.yml +++ b/modules/lissero/meta.yml @@ -41,4 +41,3 @@ output: authors: - "@rpetit3" - diff --git a/modules/macs2/callpeak/meta.yml b/modules/macs2/callpeak/meta.yml index afb949ece2a..fe0e30e42ef 100644 --- a/modules/macs2/callpeak/meta.yml +++ b/modules/macs2/callpeak/meta.yml @@ -1,10 +1,10 @@ name: macs2_callpeak description: Peak calling of enriched genomic regions of ChIP-seq and ATAC-seq experiments keywords: - - alignment - - atac-seq - - chip-seq - - peak-calling + - alignment + - atac-seq + - chip-seq + - peak-calling tools: - macs2: description: Model Based Analysis for ChIP-Seq data diff --git a/modules/muscle/meta.yml b/modules/muscle/meta.yml index d28afa725f9..ddd4b7410ae 100644 --- a/modules/muscle/meta.yml +++ b/modules/muscle/meta.yml @@ -1,15 +1,15 @@ name: muscle description: MUSCLE is a program for creating multiple alignments of amino acid or nucleotide sequences. A range of options are provided that give you the choice of optimizing accuracy, speed, or some compromise between the two keywords: - - msa - - multiple sequence alignment + - msa + - multiple sequence alignment tools: - muscle: - description: MUSCLE is a multiple sequence alignment tool with high accuracy and throughput - homepage: https://www.drive5.com/muscle - documentation: http://www.drive5.com/muscle/muscle.html#_Toc81224840 - doi: "https://pubmed.ncbi.nlm.nih.gov/15034147/" - licence: ['http://www.drive5.com/muscle/manual/license.html'] + description: MUSCLE is a multiple sequence alignment tool with high accuracy and throughput + homepage: https://www.drive5.com/muscle + documentation: http://www.drive5.com/muscle/muscle.html#_Toc81224840 + doi: "https://pubmed.ncbi.nlm.nih.gov/15034147/" + licence: ['http://www.drive5.com/muscle/manual/license.html'] input: - fasta: type: file diff --git a/modules/seacr/callpeak/meta.yml b/modules/seacr/callpeak/meta.yml index 53b3415f751..a73e85de3be 100644 --- a/modules/seacr/callpeak/meta.yml +++ b/modules/seacr/callpeak/meta.yml @@ -1,4 +1,3 @@ - name: seacr_callpeak description: Call peaks using SEACR on sequenced reads in bedgraph format keywords: @@ -11,44 +10,44 @@ keywords: - seacr tools: - seacr: - description: | - SEACR is intended to call peaks and enriched regions from sparse CUT&RUN - or chromatin profiling data in which background is dominated by "zeroes" - (i.e. regions with no read coverage). - homepage: https://github.com/FredHutch/SEACR - documentation: https://github.com/FredHutch/SEACR - licence: ['GPL-2.0-only'] + description: | + SEACR is intended to call peaks and enriched regions from sparse CUT&RUN + or chromatin profiling data in which background is dominated by "zeroes" + (i.e. regions with no read coverage). + homepage: https://github.com/FredHutch/SEACR + documentation: https://github.com/FredHutch/SEACR + licence: ['GPL-2.0-only'] input: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - bedgraph: - type: file - description: | - The target bedgraph file from which the peaks will be calculated. + type: file + description: | + The target bedgraph file from which the peaks will be calculated. - ctrlbedgraph: - type: file - description: | - Control (IgG) data bedgraph file to generate an empirical threshold for peak calling. + type: file + description: | + Control (IgG) data bedgraph file to generate an empirical threshold for peak calling. - threshold: - type: value - description: | - Threshold value used to call peaks if the ctrlbedgraph input is set to []. Set to 1 if using a control bedgraph + type: value + description: | + Threshold value used to call peaks if the ctrlbedgraph input is set to []. Set to 1 if using a control bedgraph output: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - bed: - type: file - description: Bed file containing the calculated peaks. - pattern: "*.bed" + type: file + description: Bed file containing the calculated peaks. + pattern: "*.bed" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@chris-cheshire" diff --git a/modules/seqkit/split2/meta.yml b/modules/seqkit/split2/meta.yml index 90eec7f9a5d..8691f8d6c1e 100644 --- a/modules/seqkit/split2/meta.yml +++ b/modules/seqkit/split2/meta.yml @@ -5,35 +5,35 @@ keywords: - fastq tools: - seqkit: - description: | - Cross-platform and ultrafast toolkit for FASTA/Q file manipulation, written by Wei Shen. - homepage: https://github.com/shenwei356/seqkit - documentation: https://bioinf.shenwei.me/seqkit/ - doi: 10.1371/journal.pone.0163962 - licence: ['MIT'] + description: | + Cross-platform and ultrafast toolkit for FASTA/Q file manipulation, written by Wei Shen. + homepage: https://github.com/shenwei356/seqkit + documentation: https://bioinf.shenwei.me/seqkit/ + doi: 10.1371/journal.pone.0163962 + licence: ['MIT'] input: - meta: - type: map - description: | - Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] - reads: - type: file - description: FastQ files - pattern: "*.{fq.gz/fastq.gz}" + type: file + description: FastQ files + pattern: "*.{fq.gz/fastq.gz}" output: - meta: - type: map - description: | - Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] - reads: - type: file - description: Split fastq files - pattern: "*.{fq.gz/fastq.gz}" + type: file + description: Split fastq files + pattern: "*.{fq.gz/fastq.gz}" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@FriederikeHanssen" diff --git a/modules/umitools/dedup/meta.yml b/modules/umitools/dedup/meta.yml index f89cc1ea766..8e50512408a 100644 --- a/modules/umitools/dedup/meta.yml +++ b/modules/umitools/dedup/meta.yml @@ -5,41 +5,41 @@ keywords: - deduplication tools: - umi_tools: - description: > - UMI-tools contains tools for dealing with Unique Molecular Identifiers (UMIs)/Random Molecular Tags (RMTs) - and single cell RNA-Seq cell barcodes - documentation: https://umi-tools.readthedocs.io/en/latest/ - license: ['MIT'] + description: > + UMI-tools contains tools for dealing with Unique Molecular Identifiers (UMIs)/Random Molecular Tags (RMTs) + and single cell RNA-Seq cell barcodes + documentation: https://umi-tools.readthedocs.io/en/latest/ + license: ['MIT'] input: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - bam: - type: file - description: | - BAM file containing reads to be deduplicated via UMIs. - pattern: "*.{bam}" + type: file + description: | + BAM file containing reads to be deduplicated via UMIs. + pattern: "*.{bam}" - bai: - type: file - description: | - BAM index files corresponding to the input BAM file. - pattern: "*.{bai}" + type: file + description: | + BAM index files corresponding to the input BAM file. + pattern: "*.{bai}" output: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - bam: - type: file - description: BAM file with deduplicated UMIs. - pattern: "*.{bam}" + type: file + description: BAM file with deduplicated UMIs. + pattern: "*.{bam}" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@drpatelh" diff --git a/modules/umitools/extract/meta.yml b/modules/umitools/extract/meta.yml index ae6f9feeb78..2184a00b3d5 100644 --- a/modules/umitools/extract/meta.yml +++ b/modules/umitools/extract/meta.yml @@ -5,41 +5,42 @@ keywords: - extract tools: - umi_tools: - description: > + description: > UMI-tools contains tools for dealing with Unique Molecular Identifiers (UMIs)/Random Molecular Tags (RMTs) and single cell RNA-Seq cell barcodes - documentation: https://umi-tools.readthedocs.io/en/latest/ - license: ['MIT'] + documentation: https://umi-tools.readthedocs.io/en/latest/ + license: ['MIT'] input: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - reads: - type: list - description: | - List of input FASTQ files whose UMIs will be extracted. + type: list + description: | + List of input FASTQ files whose UMIs will be extracted. output: - meta: - type: map - description: | - Groovy Map containing sample information + type: map + description: | + Groovy Map containing sample information e.g. [ id:'test', single_end:false ] - reads: - type: file - description: Extracted FASTQ files. | - For single-end reads, pattern is \${prefix}.umi_extract.fastq.gz. | + type: file + description: > + Extracted FASTQ files. | + For single-end reads, pattern is \${prefix}.umi_extract.fastq.gz. | For paired-end reads, pattern is \${prefix}.umi_extract_{1,2}.fastq.gz. - pattern: "*.{fastq.gz}" + pattern: "*.{fastq.gz}" - log: - type: file - description: Logfile for umi_tools - pattern: "*.{log}" + type: file + description: Logfile for umi_tools + pattern: "*.{log}" - versions: - type: file - description: File containing software versions - pattern: "versions.yml" + type: file + description: File containing software versions + pattern: "versions.yml" authors: - "@drpatelh"