nf-core_modules/modules/bcftools/merge/meta.yml
nvnieuwk 8656636f0d
update for bcftools merge (#1908)
* update for bcftools merge

* Update modules/bcftools/merge/main.nf

Co-authored-by: Maxime U. Garcia <maxime.garcia@scilifelab.se>

* Update modules/bcftools/merge/main.nf

Co-authored-by: Maxime U. Garcia <maxime.garcia@scilifelab.se>

* updated test.yml

* added the bed file to the main input tuple

* merged all output into one output channel

* added a test for bcf.gz output

* Update modules/bcftools/merge/main.nf

Co-authored-by: Matthias De Smet <11850640+matthdsm@users.noreply.github.com>

* updated the tests

Co-authored-by: Maxime U. Garcia <maxime.garcia@scilifelab.se>
Co-authored-by: Matthias De Smet <11850640+matthdsm@users.noreply.github.com>
2022-07-20 11:22:51 +02:00

72 lines
2.1 KiB
YAML

name: bcftools_merge
description: Merge VCF files
keywords:
- variant calling
- merge
- VCF
tools:
- merge:
description: |
Merge VCF files.
homepage: http://samtools.github.io/bcftools/bcftools.html
documentation: http://www.htslib.org/doc/bcftools.html
doi: 10.1093/bioinformatics/btp352
licence: ["MIT"]
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- vcfs:
type: files
description: |
List containing 2 or more vcf files
e.g. [ 'file1.vcf', 'file2.vcf' ]
- tbis:
type: files
description: |
List containing the tbi index files corresponding to the vcfs input files
e.g. [ 'file1.vcf.tbi', 'file2.vcf.tbi' ]
- bed:
type: file
description: "(Optional) The bed regions to merge on"
pattern: "*.bed"
- fasta:
type: file
description: "(Optional) The fasta reference file (only necessary for the `--gvcf FILE` parameter)"
pattern: "*.{fasta,fa}"
- fasta:
type: file
description: "(Optional) The fasta reference file index (only necessary for the `--gvcf FILE` parameter)"
pattern: "*.fai"
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- vcf_gz:
type: file
description: VCF merged output file (bgzipped) => when `--output-type z` is used
pattern: "*.vcf.gz"
- vcf:
type: file
description: VCF merged output file => when `--output-type v` is used
pattern: "*.vcf"
- bcf_gz:
type: file
description: BCF merged output file (bgzipped) => when `--output-type b` is used
pattern: "*.bcf.gz"
- bcf:
type: file
description: BCF merged output file => when `--output-type u` is used
pattern: "*.bcf"
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
authors:
- "@joseespinosa"
- "@drpatelh"
- "@nvnieuwk"