Added complement module with necessary test dir/parameters

software/bedtools/complement/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/bedtools/complement/main.nf

@@ -0,0 +1,36 @@
+// Import generic module functions
+include { initOptions; saveFiles; getSoftwareName } from './functions'
+
+def options    = initOptions(params.options)
+
+process BEDTOOLS_COMPLEMENT {
+    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::bedtools =2.29.2" : null)
+    if (workflow.containerEngine == 'singularity' && !params.pull_docker_container) {
+        container "https://depot.galaxyproject.org/singularity/bedtools:2.29.2--hc088bd4_0 "
+    } else {
+        container "quay.io/biocontainers/bedtools:2.29.2--hc088bd4_0"
+    }
+
+    input:
+        tuple val(meta), path(beds)
+        path  sizes
+
+    output:
+        tuple val(meta), path("*.complement.bed"), emit: complement
+        path  "*.version.txt", emit: version
+
+    script:
+        def software = getSoftwareName(task.process)
+        def beds_files = beds.sort()
+        def prefix   = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}"
+        """
+        bedtools complement -i ${beds[0]} -g $sizes ${options.args} > ${prefix}.complement.bed
+        bedtools --version | sed -e "s/Bedtools v//g" > ${software}.version.txt
+        """
+}

software/bedtools/complement/meta.yml

@@ -0,0 +1,54 @@
+name: bedtools_complement
+description: Returns all intervals in a genome that are not covered by at least one interval in the input BED/GFF/VCF file.
+
+keywords:
+    - bed
+    - complement
+tools:
+    - bedtools:
+        description: |
+            A set of tools for genomic analysis tasks, specifically enabling genome arithmetic (merge, count, complement) on various file types.
+        documentation: https://bedtools.readthedocs.io/en/latest/
+        
+params:
+    - outdir:
+        type: string
+        description: |
+            The pipeline's output directory. By default, the module will
+            output files into `$params.outdir/<SOFTWARE>`
+    - publish_dir_mode:
+        type: string
+        description: |
+            Value for the Nextflow `publishDir` mode parameter.
+            Available: symlink, rellink, link, copy, copyNoFollow, move.
+    - enable_conda:
+        type: boolean
+        description: |
+            Run the module with Conda using the software specified
+            via the `conda` directive
+
+input:
+    - meta:
+        type: map
+        description: |
+            Groovy Map containing sample information
+            e.g. [ id:'test', single_end:false ]
+    - bed:
+        type: file
+        description: List of bed files
+        pattern: "*.{bed}"
+output:
+    - meta:
+        type: map
+        description: |
+            Groovy Map containing sample information
+            e.g. [ id:'test', single_end:false ]
+    - bed:
+        type: file
+        description: Edited bed file
+        pattern: "*.{slopbed}"
+
+    - version:
+        type: file
+        description: File containing software version
+        pattern: "*.{version.txt}"

software/bedtools/complement/test/input/A.bed

@@ -0,0 +1,5 @@
+chr1	951	1061
+chr1	1300	1420
+chr1	1400	1500
+
+

software/bedtools/complement/test/input/genome.sizes

@@ -0,0 +1 @@
+chr1	1780869

software/bedtools/complement/test/main.nf

@@ -0,0 +1,24 @@
+#!/usr/bin/env nextflow
+
+nextflow.preview.dsl = 2
+include { BEDTOOLS_COMPLEMENT } from '../main.nf' addParams( options: [publish_dir:'test_bed_file'] )
+// Define input channels
+
+// Run the workflow
+workflow test_bed_file {
+    def input = []
+    input = [ [ id:'test'], 
+              [ file("${baseDir}/input/A.bed", checkIfExists: true),] ]
+
+    BEDTOOLS_COMPLEMENT(
+        input, 
+        file("${baseDir}/input/genome.sizes", checkIfExists: true)
+    )
+
+}
+
+workflow {
+    test_bed_file()
+}
+
+

software/bedtools/complement/test/nextflow.config

@@ -0,0 +1,20 @@
+  
+params {
+    outdir = "output/"
+    publish_dir_mode = "copy"
+    enable_conda = false
+}
+
+profiles {
+    conda  {
+        params.enable_conda = true
+    }
+    docker {
+        docker.enabled = true
+        docker.runOptions = '-u \$(id -u):\$(id -g)'
+    }
+    singularity {
+        singularity.enabled = true
+        singularity.autoMounts = true
+    }
+}

software/bedtools/complement/test/output/test_bed_file/test.complement.bed

@@ -0,0 +1,3 @@
+chr1	0	951
+chr1	1061	1300
+chr1	1500	1780869