Skip to content

Commit

Permalink
update JSON schema for subworkflows meta.yml (#6679)
Browse files Browse the repository at this point in the history
* update JSON schema for subworkflows meta.yml

* fix patternProperties

* manually curate some swf meta.yml files
  • Loading branch information
mirpedrol authored Oct 25, 2024
1 parent 277e706 commit 15e86fb
Show file tree
Hide file tree
Showing 12 changed files with 1,073 additions and 461 deletions.
131 changes: 96 additions & 35 deletions subworkflows/nf-core/bam_cnv_wisecondorx/meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,54 +13,115 @@ components:
- wisecondorx/predict
input:
- ch_bam:
description: |
An input channel containing BAM/CRAM files and their indices
Structure: [ val(meta), path(bam), path(bai) ]
description: An input channel containing BAM/CRAM files and their indices
structure:
- meta:
type: map
description: groovy map
- bam:
type: file
description: "BAM/CRAM file"
- bai:
type: file
description: "Index of BAM/CRAM file"
- ch_fasta:
description: |
A channel containing the reference FASTA file
Structure: [ val(meta2), path(fasta) ]
description: A channel containing the reference FASTA file
structure:
- meta2:
type: map
description: groovy map
- fasta:
type: file
description: "The reference fasta file"
- ch_fai:
description: |
A channel containing the index of the reference FASTA file
Structure: [ val(meta3), path(fai) ]
description: A channel containing the index of the reference FASTA file
structure:
- meta3:
type: map
description: groovy map
- fai:
type: file
description: "Index of reference fasta file"
- ch_ref:
description: |
A channel containing WisecondorX reference created with `WisecondorX newref`
Structure: [ val(meta4), path(reference) ]
description: A channel containing WisecondorX reference created with `WisecondorX newref`
structure:
- meta4:
type: map
description: groovy map
- reference:
type: file
description: "WisecondorX reference"
- ch_blacklist:
description: |
An optional channel containing a BED file with regions to mask from the analyis
Structure: [ val(meta5), path(blacklist) ]
description: An optional channel containing a BED file with regions to mask from the analyis
structure:
- meta5:
type: map
description: groovy map
- blacklist:
type: file
description: "BED file with regions to mask"
output:
- aberrations_bed:
description: |
A channel containing the BED files with CNV aberrations
Structure: [ val(meta), path(bed) ]
description: A channel containing the BED files with CNV aberrations
structure:
- meta:
type: map
description: groovy map
- bed:
type: file
description: "BED file with CNV aberrations"
- bins_bed:
description: |
A channel containing the BED files with the used bins
Structure: [ val(meta), path(bed) ]
description: A channel containing the BED files with the used bins
structure:
- meta:
type: map
description: groovy map
- bed:
type: file
description: "BED file with bins"
- segments_bed:
description: |
A channel containing the segment BED files
Structure: [ val(meta), path(bed) ]
description: A channel containing the segment BED files
structure:
- meta:
type: map
description: groovy map
- bed:
type: file
description: "BED file with segments"
- chr_statistics:
description: |
A channel containing TXT files with chromosome statistics
Structure: [ val(meta), path(txt) ]
description: A channel containing TXT files with chromosome statistics
structure:
- meta:
type: map
description: groovy map
- txt:
type: file
description: "TXT file with chromosome statistics"
- chr_plots:
description: |
A channel containing lists of chromosome plots
Structure: [ val(meta), [ path(png), path(png), ... ] ]
description: A channel containing lists of chromosome plots
structure:
- meta:
type: map
description: groovy map
- png:
type: list
description: "List of chromosome plots"
- genome_plot:
description: |
A channel containing the plots of the whole genomes
Structure: [ val(meta), path(png) ]
description: A channel containing the plots of the whole genomes
structure:
- meta:
type: map
description: groovy map
- png:
type: file
description: "Plot of the whole genome"
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
structure:
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
authors:
- "@nvnieuwk"
maintainers:
Expand Down
139 changes: 105 additions & 34 deletions subworkflows/nf-core/bam_create_som_pon_gatk/meta.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/subworkflows/yaml-schema.json
name: bam_create_som_pon_gatk
description: Perform variant calling on a set of normal samples using mutect2 panel of normals mode. Group them into a genomicsdbworkspace using genomicsdbimport, then use this to create a panel of normals using createsomaticpanelofnormals.
description: Perform variant calling on a set of normal samples using mutect2 panel
of normals mode. Group them into a genomicsdbworkspace using genomicsdbimport, then
use this to create a panel of normals using createsomaticpanelofnormals.
keywords:
- gatk4
- mutect2
Expand All @@ -15,54 +17,123 @@ components:
- gatk4/createsomaticpanelofnormals
input:
- ch_mutect2_in:
type: list
description: |
An input channel containing the following files:
- input: One or more BAM/CRAM files
- input_index: The index/indices from the BAM/CRAM file(s)
- interval_file: An interval file to be used with the mutect call
Structure: [ meta, input, input_index, interval_file ]
- fasta:
type: file
description: The reference fasta file
pattern: "*.fasta"
- fai:
type: file
description: Index of reference fasta file
pattern: "*.fasta.fai"
- dict:
type: file
description: GATK sequence dictionary
pattern: "*.dict"
description: An input channel containing the following files
structure:
- meta:
type: map
description: groovy map
- input:
type: file
description: "BAM/CRAM file"
- input_index:
type: file
description: "Index of BAM/CRAM file"
- interval_file:
type: file
description: "Interval file to be used with the mutect call"
- ch_fasta:
description: "The reference fasta file"
structure:
- meta:
type: map
description: groovy map
- fasta:
type: file
description: "The reference fasta file"
- ch_fai:
description: "Index of reference fasta file"
structure:
- meta:
type: map
description: groovy map
- fai:
type: file
description: "Index of reference fasta file"
- ch_dict:
description: "GATK sequence dictionary"
structure:
- meta:
type: map
description: groovy map
- dict:
type: file
description: "GATK sequence dictionary"
- val_pon_norm:
type: string
description: "name for panel of normals"
- ch_gendb_intervals:
description: "channel with interval file"
structure:
- interval_file:
type: file
description: "Interval file"
output:
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
structure:
- versions:
type: file
description: "File containing software versions"
pattern: "versions.yml"
- mutect2_vcf:
type: list
description: List of compressed vcf files to be used to make the gendb workspace
pattern: "[ *.vcf.gz ]"
structure:
- meta:
type: map
description: groovy map
- vcf:
type: file
description: "Compressed vcf file"
pattern: "*.vcf.gz"
- mutect2_index:
type: list
description: List of indexes of mutect2_vcf files
pattern: "[ *vcf.gz.tbi ]"
structure:
- meta:
type: map
description: groovy map
- tbi:
type: file
description: "Index of vcf file"
pattern: "*.vcf.gz.tbi"
- mutect2_stats:
type: list
description: List of stats files that pair with mutect2_vcf files
pattern: "[ *vcf.gz.stats ]"
structure:
- meta:
type: map
description: groovy map
- stats:
type: file
description: "Stats file"
pattern: "*vcf.gz.stats"
- genomicsdb:
type: directory
description: Directory containing the files that compose the genomicsdb workspace.
pattern: "path/name_of_workspace"
structure:
- meta:
type: map
description: groovy map
- genomicsdb:
type: directory
description: "GenomicsDB workspace"
- pon_vcf:
type: file
description: Panel of normal as compressed vcf file
pattern: "*.vcf.gz"
structure:
- meta:
type: map
description: groovy map
- vcf:
type: file
description: "Compressed vcf file"
pattern: "*.vcf.gz"
- pon_index:
type: file
description: Index of pon_vcf file
pattern: "*vcf.gz.tbi"
structure:
- meta:
type: map
description: groovy map
- tbi:
type: file
description: "Index of vcf file"
pattern: "*vcf.gz.tbi"
authors:
- "@GCJMackenzie"
maintainers:
Expand Down
Loading

0 comments on commit 15e86fb

Please sign in to comment.