diff --git a/software/lofreq/filter/functions.nf b/software/lofreq/filter/functions.nf new file mode 100644 index 00000000..da9da093 --- /dev/null +++ b/software/lofreq/filter/functions.nf @@ -0,0 +1,68 @@ +// +// 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.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) { + if (!args.filename.endsWith('.version.txt')) { + def ioptions = initOptions(args.options) + def path_list = [ ioptions.publish_dir ?: args.publish_dir ] + 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/software/lofreq/filter/main.nf b/software/lofreq/filter/main.nf new file mode 100644 index 00000000..a2b53f08 --- /dev/null +++ b/software/lofreq/filter/main.nf @@ -0,0 +1,40 @@ +// Import generic module functions +include { initOptions; saveFiles; getSoftwareName } from './functions' + +params.options = [:] +options = initOptions(params.options) + +process LOFREQ_FILTER { + 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::lofreq=2.1.5" : null) + if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) { + container "https://depot.galaxyproject.org/singularity/lofreq:2.1.5--py38h588ecb2_4" + } else { + container "quay.io/biocontainers/lofreq:2.1.5--py38h588ecb2_4" + } + + input: + tuple val(meta), path(vcf) + + output: + tuple val(meta), path("*.gz"), emit: vcf + path "*.version.txt" , emit: version + + script: + def software = getSoftwareName(task.process) + def prefix = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}" + """ + lofreq \\ + filter \\ + $options.args \\ + -i $vcf \\ + -o ${prefix}.vcf.gz + + echo \$(lofreq version 2>&1) | sed 's/^version: //; s/ *commit.*\$//' > ${software}.version.txt + """ +} diff --git a/software/lofreq/filter/meta.yml b/software/lofreq/filter/meta.yml new file mode 100644 index 00000000..9de18d4d --- /dev/null +++ b/software/lofreq/filter/meta.yml @@ -0,0 +1,44 @@ +name: lofreq_filter +description: Lofreq subcommand to remove variants with low coverage or strand bias potential +keywords: + - variant calling + - low frequency variant calling + - filtering + - lofreq + - lofreq/filter +tools: + - lofreq: + description: A fast and sensitive variant-caller for inferring SNVs and indels from next-generation sequencing data + homepage: https://csb5.github.io/lofreq/ + documentation: https://csb5.github.io/lofreq/commands/ + doi: "10.1093/nar/gks918 " + licence: ['MIT'] + +input: + - meta: + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] + - vcf: + type: file + description: VCF input file + pattern: "*.{vcf}" + +output: + - meta: + type: map + description: | + Groovy Map containing sample information + e.g. [ id:'test', single_end:false ] + - version: + type: file + description: File containing software version + pattern: "*.{version.txt}" + - vcf: + type: file + description: VCF filtered output file + pattern: "*.{vcf}" + +authors: + - "@bjohnnyd" diff --git a/tests/config/pytest_software.yml b/tests/config/pytest_software.yml index 2dffe1b1..0ec34c37 100644 --- a/tests/config/pytest_software.yml +++ b/tests/config/pytest_software.yml @@ -422,6 +422,10 @@ last/train: - software/last/train/** - tests/software/last/train/** +lofreq/filter: + - software/lofreq/filter/** + - tests/software/lofreq/filter/** + lofreq/indelqual: - software/lofreq/indelqual/** - tests/software/lofreq/indelqual/** @@ -583,14 +587,14 @@ raxmlng: - software/raxmlng/** - tests/software/raxmlng/** -rsem/preparereference: - - software/rsem/preparereference/** - - tests/software/rsem/preparereference/** - rsem/calculateexpression: - software/rsem/calculateexpression/** - tests/software/rsem/calculateexpression/** +rsem/preparereference: + - software/rsem/preparereference/** + - tests/software/rsem/preparereference/** + rseqc/bamstat: - software/rseqc/bamstat/** - tests/software/rseqc/bamstat/** diff --git a/tests/software/lofreq/filter/main.nf b/tests/software/lofreq/filter/main.nf new file mode 100644 index 00000000..172b1743 --- /dev/null +++ b/tests/software/lofreq/filter/main.nf @@ -0,0 +1,13 @@ +#!/usr/bin/env nextflow + +nextflow.enable.dsl = 2 + +include { LOFREQ_FILTER } from '../../../../software/lofreq/filter/main.nf' addParams( options: [:] ) + +workflow test_lofreq_filter { + + input = [ [ id:'test', single_end:false ], // meta map + file(params.test_data['sarscov2']['illumina']['test_vcf'], checkIfExists: true) ] + + LOFREQ_FILTER ( input ) +} diff --git a/tests/software/lofreq/filter/test.yml b/tests/software/lofreq/filter/test.yml new file mode 100644 index 00000000..56274b87 --- /dev/null +++ b/tests/software/lofreq/filter/test.yml @@ -0,0 +1,8 @@ +- name: lofreq filter test_lofreq_filter + command: nextflow run tests/software/lofreq/filter -entry test_lofreq_filter -c tests/config/nextflow.config + tags: + - lofreq + - lofreq/filter + files: + - path: output/lofreq/test.vcf.gz + md5sum: 1914d9bc5d855ff11fe89da7d795e57a