Multiqc

CHANGELOG.md

@@ -33,6 +33,7 @@ Initial release of nf-core/phaseimpute, created with the [nf-core](https://nf-co
 - [#84](https://github.com/nf-core/phaseimpute/pull/84) - Change depth computation to use SAMTOOLS_DEPTH and make separation by chromosome only if regions are specified.
 - [#85](https://github.com/nf-core/phaseimpute/pull/85) - Use external params in individual tests for tools.
 - [#86](https://github.com/nf-core/phaseimpute/pull/86) - Move `bcftools_convert` to `vcf_sites_extract_bcftools`.
+- [#88](https://github.com/nf-core/phaseimpute/pull/88) - Improve multiqc report with more information.
 
 ### `Fixed`
 

assets/multiqc_config.yml

@@ -10,6 +10,16 @@ report_section_order:
   "nf-core-phaseimpute-summary":
     order: -1002
 
+top_modules:
+  - "samtools":
+    name: "Samtools coverage before and after downsampling"
+    path_filters:
+      - "*_.stats"
+  - "bcftools":
+    name: "BCFtools stats of phased reference panel"
+    path_filters:
+      - "*_bcftools_stats.txt"
+
 export_plots: true
 
 disable_version_detection: true

assets/schema_input.json

@@ -9,8 +9,8 @@
         "properties": {
             "sample": {
                 "type": "string",
-                "pattern": "^\\S+$",
-                "errorMessage": "Sample name must be provided and cannot contain spaces",
+                "pattern": "^[a-zA-Z0-9]+$",
+                "errorMessage": "Sample name must be provided and cannot contain spaces nor special characters '_' or '.' .",
                 "meta": ["id"]
             },
             "file": {

conf/modules.config

@@ -18,12 +18,57 @@ process {
         saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
     ]
 
-    withName: 'MULTIQC' {
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:MULTIQC' {
         ext.args   = { params.multiqc_title ? "--title \"$params.multiqc_title\"" : '' }
         publishDir = [
             path: { "${params.outdir}/multiqc" },
             mode: params.publish_dir_mode,
             saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
+
+    // Stats
+    // Simulation
+    // Coverage process
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:SAMTOOLS_COVERAGE_TRT' {
+        ext.prefix = { "${meta.id}_A-truth" }
+        publishDir = [ enabled: false ]
+    }
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:SAMTOOLS_COVERAGE_SIM' {
+        ext.prefix = { "${meta.id}_B-sim" }
+        publishDir = [ enabled: false ]
+    }
+
+    // VCF
+    // PANEL
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:BCFTOOLS_STATS_PANEL' {
+        ext.prefix = { "${meta.id}" }
+        publishDir = [
+            path: { "${params.outdir}/prep_panel/stats/" },
+            mode: params.publish_dir_mode,
+            enabled: true,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
+        ]
+    }
+
+    // TRUTH
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:BCFTOOLS_STATS_TRUTH' {
+        ext.prefix = { "${meta.id}_truth" }
+        publishDir = [
+            path: { "${params.outdir}/validation/stats" },
+            mode: params.publish_dir_mode,
+            enabled: true,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
+        ]
+    }
+    // IMPUTE
+    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:BCFTOOLS_STATS_TOOLS' {
+        ext.prefix = { "${meta.id}_${meta.tools}" }
+        publishDir = [
+            path: { "${params.outdir}/imputation/stats" },
+            mode: params.publish_dir_mode,
+            enabled: true,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
+        ]
+    }
 }

conf/steps/imputation_glimpse1.config

@@ -34,7 +34,7 @@ process {
             "-Aim",
             "-C alleles"
         ].join(' ')
-        ext.prefix = { "${meta.id}.call" }
+        ext.prefix = { "${meta.id}" }
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:VCF_IMPUTE_GLIMPSE1:BAM_GL_BCFTOOLS:BCFTOOLS_ANNOTATE' {
@@ -74,6 +74,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/imputation/glimpse1/concat" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
 
@@ -84,6 +85,5 @@ process {
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:CONCAT_GLIMPSE1:BCFTOOLS_INDEX' {
         ext.args     = "--tbi"
-        ext.prefix = { "${meta.id}_glimpse1" }
     }
 }

conf/steps/imputation_glimpse2.config

@@ -20,12 +20,12 @@ process {
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:VCF_IMPUTE_GLIMPSE2:GLIMPSE2_PHASE' {
         ext.prefix   = { "${meta.id}_${meta.chunk.replace(':','_')}_glimpse2" }
         ext.args     = "--keep-monomorphic-ref-sites"
-        ext.suffix   = "vcf.gz"
+        ext.suffix   = "bcf"
         publishDir   = [ enabled: false ]
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:VCF_IMPUTE_GLIMPSE2:BCFTOOLS_INDEX_1' {
-        ext.args     = "--tbi"
+        ext.args     = "--csi"
         publishDir   = [ enabled: false ]
     }
 
@@ -45,6 +45,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/imputation/glimpse2/concat" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
 
@@ -55,7 +56,6 @@ process {
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:CONCAT_GLIMPSE2:BCFTOOLS_INDEX' {
         ext.args     = "--tbi"
-        ext.prefix = { "${meta.id}_glimpse2" }
     }
 
 }

conf/steps/imputation_quilt.config

@@ -48,6 +48,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/imputation/quilt/concat" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
 

conf/steps/imputation_stitch.config

@@ -56,11 +56,13 @@ process {
         publishDir = [
             path: { "${params.outdir}/imputation/stitch/concat" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:VCF_SAMPLES_BCFTOOLS:BCFTOOLS_PLUGINSPLIT' {
         ext.args   = "-Oz"
+        ext.suffix = "_stitch"
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:VCF_SAMPLES_BCFTOOLS:BCFTOOLS_INDEX' {

conf/steps/panel_prep.config

@@ -15,6 +15,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: false
         ]
         tag = {"${meta.id} ${meta.chr}"}
@@ -55,6 +56,7 @@ process {
         ext.prefix    = { "${meta.id}_${meta.chr}_biallelic_snps" }
         publishDir = [
             path: { "${params.outdir}/prep_panel/normalized" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
         }
@@ -63,6 +65,7 @@ process {
         ext.args     = "--tbi"
         publishDir = [
             path: { "${params.outdir}/prep_panel/normalized" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
         }
@@ -73,6 +76,7 @@ process {
         ext.prefix    = { "${meta.id}_${meta.chr}_biallelic_removed_samples" }
         publishDir = [
             path: { "${params.outdir}/prep_panel/normalized" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -81,6 +85,7 @@ process {
         ext.args     = "--tbi"
         publishDir = [
             path: { "${params.outdir}/prep_panel/normalized" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -89,6 +94,7 @@ process {
         ext.prefix   = { "${meta.id}_${meta.chr}" }
         publishDir = [
             path: { "${params.outdir}/prep_panel/compute_freq" },
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -106,6 +112,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/phasing" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: false
         ]
         tag = {"${meta.id} ${meta.chr}"}
@@ -131,6 +138,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/haplegend/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -148,6 +156,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/sites/vcf/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -157,6 +166,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/sites/vcf/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -178,6 +188,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/sites/tsv/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -192,6 +203,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/sites/tsv/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -210,6 +222,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/chunks/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
         tag = {"${meta.id} ${meta.chr}"}
@@ -220,6 +233,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/chunks/glimpse1/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -229,6 +243,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/chunks/glimpse2/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }
@@ -238,6 +253,7 @@ process {
         publishDir = [
             path: { "${params.outdir}/prep_panel/chunks/glimpse2/" },
             mode: params.publish_dir_mode,
+            saveAs: { filename -> filename.equals('versions.yml') ? null : filename },
             enabled: true
         ]
     }

conf/steps/simulation.config

@@ -57,14 +57,4 @@ process {
         ext.args = ""
         tag = {"${meta.id}"}
     }
-
-    // Coverage process
-    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:SAMTOOLS_COVERAGE_TRT' {
-        ext.prefix = { "${meta.id}_truth" }
-        publishDir = [ enabled: false ]
-    }
-    withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:SAMTOOLS_COVERAGE_SIM' {
-        ext.prefix = { "${meta.id}" }
-        publishDir = [ enabled: false ]
-    }
 }

conf/steps/validation.config

@@ -29,7 +29,7 @@ process {
             "-Aim",
             "-C alleles"
         ].join(' ')
-        ext.prefix = { "${meta.id}_truth.call" }
+        ext.prefix = { "${meta.id}_truth" }
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:GL_TRUTH:BCFTOOLS_ANNOTATE' {
@@ -43,7 +43,6 @@ process {
 
     // Concatenate the truth set
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:CONCAT_TRUTH:.*' {
-        ext.prefix = { "${meta.id}_truth_concat" }
         publishDir = [
             path: { "${params.outdir}/validation/concat" },
             mode: params.publish_dir_mode,
@@ -53,6 +52,7 @@ process {
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:CONCAT_TRUTH:BCFTOOLS_CONCAT' {
         ext.args = ["--ligate", "--output-type z",].join(' ')
+        ext.prefix = { "${meta.id}_A-truth" }
     }
 
     withName: 'NFCORE_PHASEIMPUTE:PHASEIMPUTE:CONCAT_TRUTH:BCFTOOLS_INDEX' {

conf/test.config

@@ -25,18 +25,18 @@ params {
 
     // Genome references
     fasta  = params.pipelines_testdata_base_path + "reference_genome/21_22/hs38DH.chr21_22.fa"
-    panel  = "${projectDir}/tests/csv/panel_2.csv"
+    panel  = "${projectDir}/tests/csv/panel.csv"
     phased = true
 
     // Pipeline steps
-    steps   = "impute"
+    steps  = "impute"
 
     // External params
-    chunks = "${projectDir}/tests/csv/chunks.csv"
+    chunks  = "${projectDir}/tests/csv/chunks.csv"
     posfile = "${projectDir}/tests/csv/posfile.csv"
 
     // Impute tools
-    tools  = "glimpse1"
+    tools   = "glimpse1"
 }