nf-core_modules/software/bcftools/bgzip/meta.yml

61 lines
1.8 KiB
YAML
Raw Normal View History

2021-01-30 10:22:25 +00:00
name: bcftools_bgzip
description: Compresses VCF files
keywords:
- variant calling
- compress
- VCF
tools:
- bgzip:
2021-02-01 08:28:51 +00:00
description: |
Bgzip compresses files in a similar manner to, and compatible with, gzip.
homepage: http://samtools.github.io/bcftools/bcftools.html
documentation: http://www.htslib.org/doc/bgzip.html
doi: 10.1093/bioinformatics/btp352
2021-01-30 10:22:25 +00:00
params:
- outdir:
2021-02-01 08:28:51 +00:00
type: string
description: |
The pipeline's output directory. By default, the module will
output files into `$params.outdir/<SOFTWARE>`
2021-01-30 10:22:25 +00:00
- publish_dir_mode:
2021-02-01 08:28:51 +00:00
type: string
description: |
Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move.
2021-01-30 10:22:25 +00:00
- enable_conda:
2021-02-01 08:28:51 +00:00
type: boolean
description: |
Run the module with Conda using the software specified
via the `conda` directive
2021-01-30 10:22:25 +00:00
- singularity_pull_docker_container:
2021-02-01 08:28:51 +00:00
type: boolean
description: |
Instead of directly downloading Singularity images for use with Singularity,
force the workflow to pull and convert Docker containers instead.
2021-01-30 10:22:25 +00:00
input:
- meta:
2021-02-01 08:28:51 +00:00
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
2021-01-30 10:22:25 +00:00
- vcf:
2021-02-01 08:28:51 +00:00
type: file
description: VCF text file
2021-01-30 10:22:25 +00:00
output:
2021-02-01 08:28:51 +00:00
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
2021-01-30 10:22:25 +00:00
- vcf:
2021-02-01 08:28:51 +00:00
type: file
description: Output compressed VCF file
pattern: "*.{vcf}"
2021-01-30 10:22:25 +00:00
- version:
2021-02-01 08:28:51 +00:00
type: file
description: File containing software version
pattern: "*.{version.txt}"
2021-01-30 10:22:25 +00:00
authors:
- "@joseespinosa"
- "@drpatelh"