mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-11-10 20:23:10 +00:00
41dfa13929
* test verified commit bcftools * adjust tests * add suggestions * test for actual file content
61 lines
1.8 KiB
YAML
61 lines
1.8 KiB
YAML
name: bcftools_stats
|
|
description: Generates stats from VCF files
|
|
keywords:
|
|
- variant calling
|
|
- stats
|
|
- VCF
|
|
tools:
|
|
- stats:
|
|
description: |
|
|
Parses VCF or BCF and produces text file stats which is suitable for
|
|
machine processing and can be plotted using plot-vcfstats.
|
|
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 ]
|
|
- vcf:
|
|
type: file
|
|
description: VCF input file
|
|
pattern: "*.{vcf}"
|
|
- tbi:
|
|
type: file
|
|
description: |
|
|
The tab index for the VCF file to be inspected. Optional: only required when parameter regions is chosen.
|
|
pattern: "*.tbi"
|
|
- regions:
|
|
type: file
|
|
description: |
|
|
Optionally, restrict the operation to regions listed in this file. (VCF, BED or tab-delimited)
|
|
- targets:
|
|
type: file
|
|
description: |
|
|
Optionally, restrict the operation to regions listed in this file (doesn't rely upon tbi index files)
|
|
- samples:
|
|
type: file
|
|
description: |
|
|
Optional, file of sample names to be included or excluded.
|
|
e.g. 'file.tsv'
|
|
output:
|
|
- meta:
|
|
type: map
|
|
description: |
|
|
Groovy Map containing sample information
|
|
e.g. [ id:'test', single_end:false ]
|
|
- stats:
|
|
type: file
|
|
description: Text output file containing stats
|
|
pattern: "*_{stats.txt}"
|
|
- versions:
|
|
type: file
|
|
description: File containing software versions
|
|
pattern: "versions.yml"
|
|
authors:
|
|
- "@joseespinosa"
|
|
- "@drpatelh"
|
|
- "@SusiJo"
|