nf-core_modules/modules/gatk4/mutect2/meta.yml
GCJMackenzie bd68797ffb
Mutect2 (#682)
* mutect2 files added, first draft of module code entered

* removing comment from main.nf

* removing comment from main.nf

* test added, commit made before editing yaml

* tests added, still needs final check and info/comments added

* gatk4 version changed to gatk4=4.2.0.0

* multiple sample support added, information added to module yaml file

* Update meta.yml

fixed linting error

* add keywords to meta.yml

* Corrections made to meta.yml

* removed whitespace from meta.yml

Co-authored-by: Gavin.Mackenzie <gavin.mackenzie@nibsc.org>
Co-authored-by: Maxime U. Garcia <max.u.garcia@gmail.com>
2021-09-13 16:16:23 +01:00

89 lines
2.8 KiB
YAML

name: gatk4_mutect2
description: Call somatic SNVs and indels via local assembly of haplotypes.
keywords:
- gatk4
- mutect2
- haplotype
- somatic
tools:
- gatk4:
description: |
Developed in the Data Sciences Platform at the Broad Institute, the toolkit offers a wide variety of tools
with a primary focus on variant discovery and genotyping. Its powerful processing engine
and high-performance computing features make it capable of taking on projects of any size.
homepage: https://gatk.broadinstitute.org/hc/en-us
documentation: https://gatk.broadinstitute.org/hc/en-us/categories/360002369672s
doi: 10.1158/1538-7445.AM2017-3590
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test']
- bam:
type: list
description: list of BAM files
pattern: "*.bam"
- bai:
type: list
description: list of BAM file indexes
pattern: "*.bam.bai"
- which_norm:
type: list
description: optional list of sample headers contained in the normal sample bam files (these are required for tumor_normal_pair mode)
- run_single:
type: boolean
description: Specify whether or not to run in tumor_single mode instead of tumor_normal_pair mode (will be ignored if run_pon is also true)
- run_pon:
type: boolean
description: Specify whether or not to run in panel_of_normal mode instead of tumor_normal_pair mode
- fasta:
type: file
description: The reference fasta file
pattern: "*.fasta"
- fastaidx:
type: file
description: Index of reference fasta file
pattern: "fasta.fai"
- dict:
type: file
description: GATK sequence dictionary
pattern: "*.dict"
- germline_resource:
type: file
description: Population vcf of germline sequencing, containing allele fractions.
pattern: "*.vcf.gz"
- germline_resource_idx:
type: file
description: Index file for the germline resource.
pattern: "*.vcf.gz_tbi"
- panel_of_normals:
type: file
description: vcf file to be used as a panel of normals.
pattern: "*.vcf.gz"
- panel_of_normals_idx:
type: file
description: Index for the panel of normals.
pattern: "*.vcf.gz_tbi"
output:
- vcf:
type: file
description: compressed vcf file
pattern: "*.vcf.gz"
- tbi:
type: file
description: Index of vcf file
pattern: "*vcf.gz.tbi"
- f1r2:
type: file
description: file containing information to be passed to LearnReadOrientationModel (only outputted when tumor_normal_pair mode is run)
pattern: "*.f1r2.tar.gz"
- version:
type: file
description: File containing software version
pattern: "*.version.txt"
authors:
- "@GCJMackenzie"