Added optional Bwa index parameter to skip bwamem2 index for a faster output

CHANGELOG.md

@@ -23,6 +23,9 @@ Initial release of nf-core/seqinspector, created with the [nf-core](https://nf-c
 - [#96](https://github.com/nf-core/seqinspector/pull/96) Added missing citations to citation tool
 - [#103](https://github.com/nf-core/seqinspector/pull/103) Configure full-tests
 - [#110](https://github.com/nf-core/seqinspector/pull/110) Update input schema to accept either tar file or directory as rundir, and fastq messages and patterns.
+- [#127](https://github.com/nf-core/seqinspector/pull/127) Added alignment tools - bwamem2 - index and mem
+- [#128](https://github.com/nf-core/seqinspector/pull/128) Added Picard tools - Collect Multiple Mterics to collect QC metrics
+- [#132](https://github.com/nf-core/seqinspector/pull/132) Added a bwamem2 index params for faster output
 
 ### `Fixed`
 

CITATIONS.md

@@ -28,6 +28,16 @@
 
 - [Seqtk](https://github.com/lh3/seqtk)
 
+- [BWAMEM2](https://ieeexplore.ieee.org/abstract/document/8820962)
+
+> Vasimuddin Md, Misra S, Li H, Aluru S. Efficient Architecture-Aware Acceleration of BWA-MEM for Multicore Systems. In: 2019 IEEE International Parallel and Distributed Processing Symposium (IPDPS). IEEE; 2019:314-324. doi:10.1109/IPDPS.2019.00041
+
+- [SAMTOOLS](https://academic.oup.com/bioinformatics/article/25/16/2078/204688)
+
+> Danecek P, Bonfield JK, Liddle J, et al. Twelve years of SAMtools and BCFtools. GigaScience. 2021;10(2):giab008. doi:10.1093/gigascience/giab008
+
+- [Picard Tools](https://broadinstitute.github.io/picard/)
+
 ## Software packaging/containerisation tools
 
 - [Anaconda](https://anaconda.com)

README.md

@@ -35,7 +35,11 @@
 
 1. Subsample reads ([`Seqtk`](https://github.com/lh3/seqtk))
 2. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))
-3. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))
+3. Align reads to reference with ([`Bwamem2`](https://github.com/bwa-mem2/bwa-mem2))
+4. Index aligned BAM files ([`SAMtools`](http://github.com/samtools))
+5. Create FASTA index ([`SAMtools`](http://github.com/samtools))
+6. Collect multiple QC metrics ([`Picard CollectMultipleMetrics`](https://broadinstitute.github.io/picard/picard-metric-definitions.html))
+7. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))
 
 ## Usage
 

conf/modules.config

@@ -18,11 +18,11 @@ process {
         saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
     ]
 
-    withName: SEQTK_SAMPLE {
+    withName: 'SEQTK_SAMPLE' {
         ext.args = '-s100'
     }
 
-    withName: FASTQC {
+    withName: 'FASTQC' {
         ext.args = '--quiet'
     }
 
@@ -42,13 +42,15 @@ process {
             saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
+
     withName: 'BWAMEM2_MEM' {
         publishDir = [
             path: { "${params.outdir}/bwamem2_mem" },
             mode: params.publish_dir_mode,
             saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
         ]
     }
+
     withName: 'PICARD_COLLECTMULTIPLEMETRICS' {
         publishDir = [
             path: { "${params.outdir}/picard_collectmultiplemetrics" },

main.nf

@@ -36,7 +36,6 @@ include { PIPELINE_COMPLETION     } from './subworkflows/local/utils_nfcore_seqi
 // WORKFLOW: Run main analysis pipeline depending on type of input
 //
 workflow NFCORE_SEQINSPECTOR {
-
     take:
     samplesheet // channel: samplesheet read in from --input
 
@@ -46,13 +45,14 @@ workflow NFCORE_SEQINSPECTOR {
     // WORKFLOW: Run pipeline
     //
 
-    SEQINSPECTOR (
-        samplesheet
+    SEQINSPECTOR(
+        samplesheet,
+        params.fasta,
     )
-    emit:
-    global_report   = SEQINSPECTOR.out.global_report    // channel: /path/to/multiqc_report.html
-    grouped_reports = SEQINSPECTOR.out.grouped_reports  // channel: /path/to/multiqc_report.html
 
+    emit:
+    global_report   = SEQINSPECTOR.out.global_report // channel: /path/to/multiqc_report.html
+    grouped_reports = SEQINSPECTOR.out.grouped_reports // channel: /path/to/multiqc_report.html
 }
 /*
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,14 +62,12 @@ workflow NFCORE_SEQINSPECTOR {
 
 workflow {
 
-    main:
-
 
     //
     // SUBWORKFLOW: Run initialisation tasks
     //
 
-    PIPELINE_INITIALISATION (
+    PIPELINE_INITIALISATION(
         params.version,
         params.validate_params,
         params.monochrome_logs,
@@ -84,13 +82,13 @@ workflow {
     //
     // WORKFLOW: Run main workflow
     //
-    NFCORE_SEQINSPECTOR (
-        PIPELINE_INITIALISATION.out.samplesheet,
+    NFCORE_SEQINSPECTOR(
+        PIPELINE_INITIALISATION.out.samplesheet
     )
     //
     // SUBWORKFLOW: Run completion tasks
     //
-    PIPELINE_COMPLETION (
+    PIPELINE_COMPLETION(
         params.email,
         params.email_on_fail,
         params.plaintext_email,
@@ -119,9 +117,3 @@ def getGenomeAttribute(attribute) {
     }
     return null
 }
-
-/*
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    THE END
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-*/

nextflow.config

@@ -19,6 +19,7 @@ params {
     igenomes_base              = 's3://ngi-igenomes/igenomes/'
     igenomes_ignore            = false
     sort_bam                   = true
+    bwa_index                  = null
 
     // Fastqscreen options
     fastq_screen_references    = "${projectDir}/assets/example_fastq_screen_references.csv"

nextflow_schema.json

@@ -214,7 +214,8 @@
                 "modules_testdata_base_path": {
                     "type": "string",
                     "description": "Base path / URL for data used in the modules",
-                    "hidden": true
+                    "hidden": true,
+                    "default": "s3://ngi-igenomes/testdata/nf-core/modules/"
                 },
                 "multiqc_config": {
                     "type": "string",
@@ -282,5 +283,10 @@
         {
             "$ref": "#/$defs/generic_options"
         }
-    ]
+    ],
+    "properties": {
+        "bwa_index": {
+            "type": "string"
+        }
+    }
 }