Dealing with optional and mandatory GATK resource files

CHANGELOG.md

@@ -93,6 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#587](https://github.com/nf-core/sarek/pull/587) - Fix issue with VEP extra files
 - [#581](https://github.com/nf-core/sarek/pull/581) - `TIDDIT` is back
 - [#590](https://github.com/nf-core/sarek/pull/590) - Fix empty folders during scatter/gather
+- [#592](https://github.com/nf-core/sarek/pull/592) - Fix optional resources for Mutect2, GetPileupSummaries, and HaplotypeCaller: issue [#299](https://github.com/nf-core/sarek/issues/299), [#359](https://github.com/nf-core/sarek/issues/359), [#367](https://github.com/nf-core/sarek/issues/367)
 
 ### Deprecated
 

conf/modules.config

@@ -808,8 +808,8 @@ process{
         ext.args         = { "-tumor-segmentation ${meta.id}.segmentation.table" }
         publishDir        = [
             mode: params.publish_dir_mode,
-            path: { "${params.outdir}/variant_calling/${meta.id}/mutect2" },
-            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
+            path: { "${params.outdir}/variant_calling/" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : "${meta.id}/mutect2/${filename}" }
         ]
     }
 
@@ -825,8 +825,8 @@ process{
         ext.prefix       = {"${meta.id}.filtered"}
         publishDir       = [
             mode: params.publish_dir_mode,
-            path: { "${params.outdir}/variant_calling/${meta.id}/mutect2" },
-            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
+            path: { "${params.outdir}/variant_calling/" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : "${meta.id}/mutect2/${filename}" }
         ]
     }
 
@@ -846,13 +846,22 @@ process{
         ]
     }
 
-    withName: 'GETPILEUPSUMMARIES.*' {
+     withName: 'GETPILEUPSUMMARIES.*' {
         ext.prefix       = { meta.num_intervals <= 1 ? meta.id : "${meta.id}_${intervals.simpleName}" }
         publishDir        = [
             mode: params.publish_dir_mode,
-            path: { "${params.outdir}/variant_calling/${meta.id}/" },
+            path: { "${params.outdir}/variant_calling/" },
+            pattern: "*.table",
+            saveAs: { meta.num_intervals > 1 ? null : "${meta.id}/mutect2/${it}" }
+        ]
+    }
+
+    withName: 'GETPILEUPSUMMARIES_.*' {
+        publishDir        = [
+            mode: params.publish_dir_mode,
+            path: { "${params.outdir}/variant_calling/" },
             pattern: "*.table",
-            saveAs: { meta.num_intervals > 1 ? null : "mutect2/${it}" }
+            saveAs: { meta.num_intervals > 1 ? null : "${meta.tumor_id}_vs_${meta.normal_id}/mutect2/${it}" }
         ]
     }
 
@@ -880,9 +889,9 @@ process{
         ext.args         = { params.ignore_soft_clipped_bases ? "--dont-use-soft-clipped-bases true --f1r2-tar-gz ${task.ext.prefix}.f1r2.tar.gz" : "--f1r2-tar-gz ${task.ext.prefix}.f1r2.tar.gz" }
         publishDir       = [
             mode: params.publish_dir_mode,
-            path: { "${params.outdir}/variant_calling/${meta.id}/" },
+            path: { "${params.outdir}/variant_calling/" },
             pattern: "*{vcf.gz,vcf.gz.tbi,stats}",
-            saveAs: { meta.num_intervals > 1 ? null : "mutect2/${it}" }
+            saveAs: { meta.num_intervals > 1 ? null : "${meta.id}/mutect2/${it}" }
         ]
     }
 

modules.json

@@ -130,7 +130,7 @@
                 "git_sha": "169b2b96c1167f89ab07127b7057c1d90a6996c7"
             },
             "gatk4/getpileupsummaries": {
-                "git_sha": "f40cfefc0899fd6bb6adc300142ca6c3a35573ff"
+                "git_sha": "1ac223ad436c1410e9c16a5966274b7ca1f8d855"
             },
             "gatk4/haplotypecaller": {
                 "git_sha": "169b2b96c1167f89ab07127b7057c1d90a6996c7"

subworkflows/local/prepare_genome.nf

@@ -52,7 +52,6 @@ workflow PREPARE_GENOME {
     TABIX_PON(pon.flatten().map{ it -> [[id:it.baseName], it] })
 
     chr_files = chr_dir
-    //TODO this works, but is not pretty. I will leave this in your hands during refactoring @Maxime
     if ( params.chr_dir.endsWith('tar.gz')){
         UNTAR_CHR_DIR(chr_dir.map{ it -> [[id:it[0].baseName], it] })
         chr_files = UNTAR_CHR_DIR.out.untar.map{ it[1] }
@@ -71,16 +70,16 @@ workflow PREPARE_GENOME {
     ch_versions = ch_versions.mix(TABIX_PON.out.versions)
 
     emit:
-        bwa                              = BWAMEM1_INDEX.out.index                                        // path: bwa/*
-        bwamem2                          = BWAMEM2_INDEX.out.index                                        // path: bwamem2/*
-        hashtable                        = DRAGMAP_HASHTABLE.out.hashmap                                  // path: dragmap/*
-        dbsnp_tbi                        = TABIX_DBSNP.out.tbi.map{ meta, tbi -> [tbi] }.collect()        // path: dbsnb.vcf.gz.tbi 
-        dict                             = GATK4_CREATESEQUENCEDICTIONARY.out.dict                        // path: genome.fasta.dict
-        fasta_fai                        = SAMTOOLS_FAIDX.out.fai.map{ meta, fai -> [fai] }               // path: genome.fasta.fai
-        germline_resource_tbi            = TABIX_GERMLINE_RESOURCE.out.tbi.map{ meta, tbi -> [tbi] }.collect()      // path: germline_resource.vcf.gz.tbi
-        known_indels_tbi                 = TABIX_KNOWN_INDELS.out.tbi.map{ meta, tbi -> [tbi] }.collect() // path: {known_indels*}.vcf.gz.tbi
-        msisensorpro_scan                = MSISENSORPRO_SCAN.out.list.map{ meta, list -> [list] }         // path: genome_msi.list
-        pon_tbi                          = TABIX_PON.out.tbi.map{ meta, tbi -> [tbi] }.collect()          // path: pon.vcf.gz.tbi
+        bwa                              = BWAMEM1_INDEX.out.index                                             // path: bwa/*
+        bwamem2                          = BWAMEM2_INDEX.out.index                                             // path: bwamem2/*
+        hashtable                        = DRAGMAP_HASHTABLE.out.hashmap                                       // path: dragmap/*
+        dbsnp_tbi                        = TABIX_DBSNP.out.tbi.map{ meta, tbi -> [tbi] }.collect()             // path: dbsnb.vcf.gz.tbi
+        dict                             = GATK4_CREATESEQUENCEDICTIONARY.out.dict                             // path: genome.fasta.dict
+        fasta_fai                        = SAMTOOLS_FAIDX.out.fai.map{ meta, fai -> [fai] }                    // path: genome.fasta.fai
+        germline_resource_tbi            = TABIX_GERMLINE_RESOURCE.out.tbi.map{ meta, tbi -> [tbi] }.collect() // path: germline_resource.vcf.gz.tbi
+        known_indels_tbi                 = TABIX_KNOWN_INDELS.out.tbi.map{ meta, tbi -> [tbi] }.collect()      // path: {known_indels*}.vcf.gz.tbi
+        msisensorpro_scan                = MSISENSORPRO_SCAN.out.list.map{ meta, list -> [list] }              // path: genome_msi.list
+        pon_tbi                          = TABIX_PON.out.tbi.map{ meta, tbi -> [tbi] }.collect()               // path: pon.vcf.gz.tbi
         chr_files                        = chr_files
-        versions                         = ch_versions                                                    // channel: [ versions.yml ]
+        versions                         = ch_versions                                                         // channel: [ versions.yml ]
 }

tests/test_tools.yml

@@ -430,10 +430,18 @@
     - no_intervals
     - tumor_only
     - variant_calling
-  exit_code: 1
-  stdout:
-    contains:
-      - "--tools mutect2 and --no_intervals cannot be used together."
+  files:
+    - path: results/variant_calling/sample2/mutect2/sample2.vcf.gz
+    - path: results/variant_calling/sample2/mutect2/sample2.vcf.gz.tbi
+    - path: results/variant_calling/sample2/mutect2/sample2.vcf.gz.stats
+    - path: results/variant_calling/sample2/mutect2/sample2.contamination.table
+    - path: results/variant_calling/sample2/mutect2/sample2.segmentation.table
+    - path: results/variant_calling/sample2/mutect2/sample2.artifactprior.tar.gz
+    - path: results/variant_calling/sample2/mutect2/sample2.pileupsummaries.table
+    - path: results/variant_calling/sample2/mutect2/sample2.filtered.vcf.gz
+    - path: results/variant_calling/sample2/mutect2/sample2.filtered.vcf.gz.tbi
+    - path: results/variant_calling/sample2/mutect2/sample2.filtered.vcf.gz.filteringStats.tsv
+    - path: results/csv/variantcalled.csv
 
 - name: Run variant calling on somatic sample with mutect2
   command: nextflow run main.nf -profile test,tools_somatic,docker --tools mutect2 -c ./tests/nextflow.config
@@ -456,16 +464,25 @@
     - path: results/csv/variantcalled.csv
 
 - name: Run variant calling on somatic sample with mutect2 without intervals
-  command: nextflow run main.nf -profile test,tools_somatic,docker --tools mutect2 --no_intervals
+  command: nextflow run main.nf -profile test,tools_somatic,docker --tools mutect2 --no_intervals -c ./tests/nextflow.config
   tags:
     - mutect2
     - no_intervals
     - somatic
     - variant_calling
-  exit_code: 1
-  stdout:
-    contains:
-      - "--tools mutect2 and --no_intervals cannot be used together."
+  files:
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.vcf.gz
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.vcf.gz.tbi
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.vcf.gz.stats
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.contamination.table
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.segmentation.table
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample3.pileupsummaries.table
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4.pileupsummaries.table
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.artifactprior.tar.gz
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.filtered.vcf.gz
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.filtered.vcf.gz.tbi
+    - path: results/variant_calling/sample4_vs_sample3/mutect2/sample4_vs_sample3.filtered.vcf.gz.filteringStats.tsv
+    - path: results/csv/variantcalled.csv
 
 - name: Run variant calling on somatic sample with msisensor-pro
   command: nextflow run main.nf -profile test,tools_somatic,docker --tools msisensorpro