Add ivar consensus

software/ivar/consensus/functions.nf

@@ -0,0 +1,59 @@
+/*
+ * -----------------------------------------------------
+ *  Utility functions used in nf-core DSL2 module files
+ * -----------------------------------------------------
+ */
+
+/*
+ * Extract name of software tool from process name using $task.process
+ */
+def getSoftwareName(task_process) {
+    return task_process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()
+}
+
+/*
+ * Function to initialise default values and to generate a Groovy Map of available options for nf-core modules
+ */
+def initOptions(Map args) {
+    def Map options = [:]
+    options.args          = args.args ?: ''
+    options.args2         = args.args2 ?: ''
+    options.publish_by_id = args.publish_by_id ?: false
+    options.publish_dir   = args.publish_dir ?: ''
+    options.publish_files = args.publish_files
+    options.suffix        = args.suffix ?: ''
+    return options
+}
+
+/*
+ * Tidy up and join elements of a list to return a path string
+ */
+def getPathFromList(path_list) {
+    def paths = path_list.findAll { item -> !item?.trim().isEmpty() }  // Remove empty entries
+    paths = paths.collect { it.trim().replaceAll("^[/]+|[/]+\$", "") } // Trim whitespace and trailing slashes
+    return paths.join('/')
+}
+
+/*
+ * Function to save/publish module results
+ */
+def saveFiles(Map args) {
+    if (!args.filename.endsWith('.version.txt')) {
+        def ioptions = initOptions(args.options)
+        def path_list = [ ioptions.publish_dir ?: args.publish_dir ]
+        if (ioptions.publish_by_id) {
+            path_list.add(args.publish_id)
+        }
+        if (ioptions.publish_files instanceof Map) {
+            for (ext in ioptions.publish_files) {
+                if (args.filename.endsWith(ext.key)) {
+                    def ext_list = path_list.collect()
+                    ext_list.add(ext.value)
+                    return "${getPathFromList(ext_list)}/$args.filename"
+                }
+            }
+        } else if (ioptions.publish_files == null) {
+            return "${getPathFromList(path_list)}/$args.filename"
+        }
+    }
+}

software/ivar/consensus/main.nf

@@ -0,0 +1,46 @@
+// Import generic module functions
+include { initOptions; saveFiles; getSoftwareName } from './functions'
+
+params.options = [:]
+def options    = initOptions(params.options)
+
+process IVAR_CONSENSUS {
+    tag "$meta.id"
+    label 'process_medium'
+    publishDir "${params.outdir}",
+        mode: params.publish_dir_mode,
+        saveAs: { filename -> saveFiles(filename:filename, options:params.options, publish_dir:getSoftwareName(task.process), publish_id:meta.id) }
+
+    conda (params.enable_conda ? "bioconda::ivar=1.3.1" : null)
+
+    if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) {
+        container "https://depot.galaxyproject.org/singularity/ivar:1.3.1--h089eab3_0"
+    } else {
+        container "quay.io/biocontainers/ivar:1.3.1--h089eab3_0"
+    }
+
+    input:
+    tuple val(meta), path(bam)
+
+    output:
+    tuple val(meta), path("*.fa")      , emit: cns_seq
+    tuple val(meta), path("*.qual.txt"), emit: cns_qual
+    tuple val(meta), path("*_mpileup.txt"), emit: mpileup
+    path "*.version.txt"               , emit: version
+
+    script:
+    def software = getSoftwareName(task.process)
+    def prefix   = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}"
+    """
+    samtools mpileup \\
+        -aa -A -d 0 -Q 0 \\
+        $options.args2 \\
+        $bam | \\
+        tee ${prefix}_mpileup.txt | \\
+        ivar consensus \\
+        $options.args \\
+        -p $prefix
+
+    ivar version | head -n1 2>&1 | sed 's/^.*iVar version //g' > ${software}.version.txt
+    """
+}

tests/software/ivar/consensus/main.nf

@@ -0,0 +1,19 @@
+#!/usr/bin/env nextflow
+
+nextflow.enable.dsl = 2
+params.publish_dir_mode = 'link'
+params.enable_conda = false
+
+include { IVAR_CONSENSUS } from '../../../../software/ivar/consensus/main.nf' addParams([:])
+
+workflow test_ivar_consensus {
+    
+    bam = file("${launchDir}/tests/data/bam/test-sc2-artic-v3.bam", checkIfExists: true)
+
+    def input = []
+    input = [ [ id:'test'], 
+                file("${launchDir}/tests/data/bam/test-sc2-artic-v3-sorted-trimmed.bam", checkIfExists: true) ]
+
+    main:
+      IVAR_CONSENSUS ( input )
+}

tests/software/ivar/consensus/test.yml

@@ -0,0 +1,13 @@
+- name: Run ivar consensus test workflow
+  command: nextflow run ./tests/software/ivar/consensus -profile docker -entry test_ivar_consensus -c tests/config/nextflow.config
+  tags:
+    - ivar
+    - ivar_consensus
+  files:
+    - path: output/ivar/test.fa
+      md5sum: d791e777b669bd40f6074b5566722a47
+    - path: output/ivar/test.qual.txt
+      md5sum: 723126475ec74adfd876e2b47ffe35a8
+    - path: output/ivar/test_mpileup.txt
+      md5sum: d1c0ef3978bec1c09c549f884ed5b76a
+