From 4bd530135fe2a78bdfec2d710b9d294fb447c245 Mon Sep 17 00:00:00 2001 From: "Robert A. Petit III" Date: Wed, 10 Nov 2021 11:25:50 -0700 Subject: [PATCH] add ngmaster module (#1024) * add ngmaster module * add docker container Co-authored-by: Gregor Sturm --- modules/ngmaster/functions.nf | 78 +++++++++++++++++++++++++++++++++ modules/ngmaster/main.nf | 41 +++++++++++++++++ modules/ngmaster/meta.yml | 43 ++++++++++++++++++ tests/config/pytest_modules.yml | 4 ++ tests/modules/ngmaster/main.nf | 13 ++++++ tests/modules/ngmaster/test.yml | 7 +++ 6 files changed, 186 insertions(+) create mode 100644 modules/ngmaster/functions.nf create mode 100644 modules/ngmaster/main.nf create mode 100644 modules/ngmaster/meta.yml create mode 100644 tests/modules/ngmaster/main.nf create mode 100644 tests/modules/ngmaster/test.yml diff --git a/modules/ngmaster/functions.nf b/modules/ngmaster/functions.nf new file mode 100644 index 00000000..85628ee0 --- /dev/null +++ b/modules/ngmaster/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/ngmaster/main.nf b/modules/ngmaster/main.nf new file mode 100644 index 00000000..1897b5f3 --- /dev/null +++ b/modules/ngmaster/main.nf @@ -0,0 +1,41 @@ +// Import generic module functions +include { initOptions; saveFiles; getSoftwareName; getProcessName } from './functions' + +params.options = [:] +options = initOptions(params.options) + +process NGMASTER { + 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::ngmaster=0.5.8" : null) + if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) { + container "https://depot.galaxyproject.org/singularity/ngmaster:0.5.8--pyhdfd78af_1" + } else { + container "quay.io/biocontainers/ngmaster:0.5.8--pyhdfd78af_1" + } + + input: + tuple val(meta), path(fasta) + + output: + tuple val(meta), path("*.tsv"), emit: tsv + path "versions.yml" , emit: versions + + script: + def prefix = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}" + """ + ngmaster \\ + $options.args \\ + $fasta \\ + > ${prefix}.tsv + + cat <<-END_VERSIONS > versions.yml + ${getProcessName(task.process)}: + ${getSoftwareName(task.process)}: \$( echo \$(ngmaster --version 2>&1) | sed 's/^.*ngmaster //' ) + END_VERSIONS + """ +} diff --git a/modules/ngmaster/meta.yml b/modules/ngmaster/meta.yml new file mode 100644 index 00000000..1dbb02a0 --- /dev/null +++ b/modules/ngmaster/meta.yml @@ -0,0 +1,43 @@ +name: ngmaster +description: Serotyping Neisseria gonorrhoeae assemblies +keywords: + - fasta + - Neisseria gonorrhoeae + - serotype +tools: + - ngmaster: + description: In silico multi-antigen sequence typing for Neisseria gonorrhoeae (NG-MAST) + homepage: https://github.com/MDU-PHL/ngmaster/blob/master/README.md + documentation: https://github.com/MDU-PHL/ngmaster/blob/master/README.md + tool_dev_url: https://github.com/MDU-PHL/ngmaster + doi: "10.1099/mgen.0.000076" + licence: ['GPL v3 only'] + +input: + - meta: + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] + - fasta: + type: file + description: FASTA assembly file + pattern: "*.{fasta,fasta.gz,fa,fa.gz,fna,fna.gz}" + +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" + - tsv: + type: file + description: Tab-delimited result file + pattern: "*.tsv" + +authors: + - "@rpetit3" diff --git a/tests/config/pytest_modules.yml b/tests/config/pytest_modules.yml index 8dfe67cf..8c169fcd 100644 --- a/tests/config/pytest_modules.yml +++ b/tests/config/pytest_modules.yml @@ -860,6 +860,10 @@ nextclade: - modules/nextclade/** - tests/modules/nextclade/** +ngmaster: + - modules/ngmaster/** + - tests/modules/ngmaster/** + optitype: - modules/optitype/** - tests/modules/optitype/** diff --git a/tests/modules/ngmaster/main.nf b/tests/modules/ngmaster/main.nf new file mode 100644 index 00000000..8bc975ed --- /dev/null +++ b/tests/modules/ngmaster/main.nf @@ -0,0 +1,13 @@ +#!/usr/bin/env nextflow + +nextflow.enable.dsl = 2 + +include { NGMASTER } from '../../../modules/ngmaster/main.nf' addParams( options: [:] ) + +workflow test_ngmaster { + + input = [ [ id:'test', single_end:false ], // meta map + file(params.test_data['sarscov2']['genome']['genome_fasta'], checkIfExists: true) ] + + NGMASTER ( input ) +} diff --git a/tests/modules/ngmaster/test.yml b/tests/modules/ngmaster/test.yml new file mode 100644 index 00000000..31584a54 --- /dev/null +++ b/tests/modules/ngmaster/test.yml @@ -0,0 +1,7 @@ +- name: ngmaster test_ngmaster + command: nextflow run tests/modules/ngmaster -entry test_ngmaster -c tests/config/nextflow.config + tags: + - ngmaster + files: + - path: output/ngmaster/test.tsv + md5sum: cf674474eaf8ac6abfcebce0af0226cf