diff --git a/modules/mtnucratio/functions.nf b/modules/mtnucratio/functions.nf new file mode 100644 index 00000000..85628ee0 --- /dev/null +++ b/modules/mtnucratio/functions.nf @@ -0,0 +1,78 @@ +// +// 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() +} + +// +// Extract name of module from process name using $task.process +// +def getProcessName(task_process) { + return task_process.tokenize(':')[-1] +} + +// +// 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.args3 = args.args3 ?: '' + options.publish_by_meta = args.publish_by_meta ?: [] + 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) { + def ioptions = initOptions(args.options) + def path_list = [ ioptions.publish_dir ?: args.publish_dir ] + + // Do not publish versions.yml unless running from pytest workflow + if (args.filename.equals('versions.yml') && !System.getenv("NF_CORE_MODULES_TEST")) { + return null + } + if (ioptions.publish_by_meta) { + def key_list = ioptions.publish_by_meta instanceof List ? ioptions.publish_by_meta : args.publish_by_meta + for (key in key_list) { + if (args.meta && key instanceof String) { + def path = key + if (args.meta.containsKey(key)) { + path = args.meta[key] instanceof Boolean ? "${key}_${args.meta[key]}".toString() : args.meta[key] + } + path = path instanceof String ? path : '' + path_list.add(path) + } + } + } + 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" + } +} diff --git a/modules/mtnucratio/main.nf b/modules/mtnucratio/main.nf new file mode 100644 index 00000000..28d08a13 --- /dev/null +++ b/modules/mtnucratio/main.nf @@ -0,0 +1,43 @@ +include { initOptions; saveFiles; getSoftwareName; getProcessName } from './functions' + +params.options = [:] +options = initOptions(params.options) + +process MTNUCRATIO { + tag "$meta.id" + label 'process_low' + publishDir "${params.outdir}", + mode: params.publish_dir_mode, + saveAs: { filename -> saveFiles(filename:filename, options:params.options, publish_dir:getSoftwareName(task.process), meta:meta, publish_by_meta:['id']) } + + conda (params.enable_conda ? "bioconda::mtnucratio=0.7" : null) + if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) { + container "https://depot.galaxyproject.org/singularity/mtnucratio:0.7--hdfd78af_2" + } else { + container "quay.io/biocontainers/mtnucratio:0.7--hdfd78af_2" + } + + input: + tuple val(meta), path(bam) + val(mt_id) + + output: + tuple val(meta), path("*.mtnucratio"), emit: mtnucratio + tuple val(meta), path("*.json") , emit: json + path "versions.yml" , emit: versions + + script: + def prefix = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}" + + """ + mtnucratio \\ + $options.args \\ + $bam \\ + $mt_id + + cat <<-END_VERSIONS > versions.yml + ${getProcessName(task.process)}: + ${getSoftwareName(task.process)}: \$(echo \$(mtnucratio --version 2>&1) | head -n1 | sed 's/Version: //') + END_VERSIONS + """ +} diff --git a/modules/mtnucratio/meta.yml b/modules/mtnucratio/meta.yml new file mode 100644 index 00000000..824af397 --- /dev/null +++ b/modules/mtnucratio/meta.yml @@ -0,0 +1,54 @@ +name: mtnucratio +description: A small Java tool to calculate ratios between MT and nuclear sequencing reads in a given BAM file. +keywords: + - mtnucratio + - ratio + - reads + - bam + - mitochondrial to nuclear ratio + - mitochondria + - statistics +tools: + - mtnucratio: + description: A small tool to determine MT to Nuclear ratios for NGS data. + homepage: https://github.com/apeltzer/MTNucRatioCalculator + documentation: https://github.com/apeltzer/MTNucRatioCalculator + tool_dev_url: https://github.com/apeltzer/MTNucRatioCalculator + doi: "10.1186/s13059-016-0918-z" + licence: ['GPL v3'] + +input: + - meta: + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] + - bam: + type: file + description: (coordinate) sorted BAM/SAM file + pattern: "*.{bam,sam}" + - mt_id: + type: string + description: Identifier of the contig/chromosome of interest (e.g. chromosome, contig) as in the aligned against reference FASTA file, e.g. mt or chrMT for mitochondria + +output: + - meta: + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] + - versions: + type: file + description: File containing software versions + pattern: "versions.yml" + - mtnucratio: + type: file + description: Text file containing metrics (mtreads, mt_cov_avg, nucreads, nuc_cov_avg, mt_nuc_ratio) + pattern: "*.mtnucratio" + - json: + type: file + description: JSON file, containing metadata map with sample name, tool name and version, and metrics as in txt file + pattern: "*.json" + +authors: + - "@louperelo" diff --git a/tests/config/pytest_modules.yml b/tests/config/pytest_modules.yml index 155ed78d..c0936a81 100644 --- a/tests/config/pytest_modules.yml +++ b/tests/config/pytest_modules.yml @@ -778,6 +778,10 @@ msisensor/scan: - modules/msisensor/scan/** - tests/modules/msisensor/scan/** +mtnucratio: + - modules/mtnucratio/** + - tests/modules/mtnucratio/** + multiqc: - modules/fastqc/** - modules/multiqc/** diff --git a/tests/modules/mtnucratio/main.nf b/tests/modules/mtnucratio/main.nf new file mode 100644 index 00000000..dd9fc9db --- /dev/null +++ b/tests/modules/mtnucratio/main.nf @@ -0,0 +1,14 @@ +#!/usr/bin/env nextflow + +nextflow.enable.dsl = 2 + +include { MTNUCRATIO } from '../../../modules/mtnucratio/main.nf' addParams( options: [:] ) + +workflow test_mtnucratio { + + input = [ [ id:'test', single_end:false ], // meta map + file(params.test_data['sarscov2']['illumina']['test_single_end_sorted_bam'], checkIfExists: true)] + mt_id = 'mt_id' + + MTNUCRATIO ( input, mt_id ) +} diff --git a/tests/modules/mtnucratio/test.yml b/tests/modules/mtnucratio/test.yml new file mode 100644 index 00000000..76cbaf32 --- /dev/null +++ b/tests/modules/mtnucratio/test.yml @@ -0,0 +1,9 @@ +- name: mtnucratio + command: nextflow run tests/modules/mtnucratio -entry test_mtnucratio -c tests/config/nextflow.config + tags: + - mtnucratio + files: + - path: output/mtnucratio/test.single_end.sorted.bam.mtnucratio + md5sum: 19e96849802c70aa0694785f716274b7 + - path: output/mtnucratio/test.single_end.sorted.bam.mtnucratiomtnuc.json + md5sum: 14d24be6272854d6762f0dfad5918ef6