mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-12-23 19:48:16 +00:00
63 lines
1.9 KiB
YAML
63 lines
1.9 KiB
YAML
name: bcftools_tabix
|
|
description: Index GFF/BED/SAM/VCF file
|
|
keywords:
|
|
- index
|
|
- vcf
|
|
- bed
|
|
- sam
|
|
- gff
|
|
tools:
|
|
- stats:
|
|
description: |
|
|
Indexes a TAB-delimited genome position file.
|
|
homepage: http://samtools.github.io/bcftools/bcftools.html
|
|
documentation: http://www.htslib.org/doc/bcftools.html
|
|
doi: 10.1093/bioinformatics/btp352
|
|
params:
|
|
- outdir:
|
|
type: string
|
|
description: |
|
|
The pipeline's output directory. By default, the module will
|
|
output files into `$params.outdir/<SOFTWARE>`
|
|
- publish_dir_mode:
|
|
type: string
|
|
description: |
|
|
Value for the Nextflow `publishDir` mode parameter.
|
|
Available: symlink, rellink, link, copy, copyNoFollow, move.
|
|
- enable_conda:
|
|
type: boolean
|
|
description: |
|
|
Run the module with Conda using the software specified
|
|
via the `conda` directive
|
|
- singularity_pull_docker_container:
|
|
type: boolean
|
|
description: |
|
|
Instead of directly downloading Singularity images for use with Singularity,
|
|
force the workflow to pull and convert Docker containers instead.
|
|
input:
|
|
- meta:
|
|
type: map
|
|
description: |
|
|
Groovy Map containing sample information
|
|
e.g. [ id:'test', single_end:false ]
|
|
- vcf:
|
|
type: file
|
|
description: TAB-delimited genome position file compressed with bgzip
|
|
pattern: "*.{vcf.gz,bed.gz,sam.gz,gff.gz}"
|
|
output:
|
|
- meta:
|
|
type: map
|
|
description: |
|
|
Groovy Map containing sample information
|
|
e.g. [ id:'test', single_end:false ]
|
|
- tbi:
|
|
type: file
|
|
description: Index file
|
|
pattern: "*.{tbi}"
|
|
- version:
|
|
type: file
|
|
description: File containing software version
|
|
pattern: "*.{version.txt}"
|
|
authors:
|
|
- "@joseespinosa"
|
|
- "@drpatelh"
|