Pairtools sort (#524)

* add software/pairtools

* create a branch for pairtools/sort

* fix the different output of conda and docker.

* remove customized code.

* Apply suggestions from code review

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

software/pairtools/sort/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"
+        }
+    }
+}

software/pairtools/sort/main.nf

@@ -0,0 +1,43 @@
+// Import generic module functions
+include { initOptions; saveFiles; getSoftwareName } from './functions'
+
+params.options = [:]
+options        = initOptions(params.options)
+
+process PAIRTOOLS_SORT {
+    tag "$meta.id"
+    label 'process_high'
+    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::pairtools=0.3.0" : null)
+    if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) {
+        container "https://depot.galaxyproject.org/singularity/pairtools:0.3.0--py37hb9c2fc3_5"
+    } else {
+        container "quay.io/biocontainers/pairtools:0.3.0--py37hb9c2fc3_5"
+    }
+
+    input:
+    tuple val(meta), path(input)
+
+    output:
+    tuple val(meta), path("*.pairs.gz"), emit: sorted
+    path "*.version.txt"               , emit: version
+
+    script:
+    def software = getSoftwareName(task.process)
+    def prefix   = options.suffix ? "${meta.id}${options.suffix}" : "${meta.id}"
+    def mem      = task.memory.toString().replaceAll(/(\s|\.|B)+/, '')
+    """
+    pairtools \\
+        sort \\
+        $options.args \\
+        --nproc $task.cpus \\
+        --memory "$mem" \\
+        -o ${prefix}.pairs.gz \\
+        $input
+
+    echo \$(pairtools --version 2>&1) | sed 's/pairtools.*version //' > ${software}.version.txt
+    """
+}

software/pairtools/sort/meta.yml

@@ -0,0 +1,40 @@
+name: pairtools_sort
+description: Sort a .pairs/.pairsam file
+keywords:
+  - sort
+tools:
+  - pairtools:
+      description: CLI tools to process mapped Hi-C data
+      homepage: http://pairtools.readthedocs.io/
+      documentation: http://pairtools.readthedocs.io/
+      tool_dev_url: https://github.com/mirnylab/pairtools
+      doi: ""
+      licence: ['MIT']
+
+input:
+  - meta:
+      type: map
+      description: |
+        Groovy Map containing sample information
+        e.g. [ id:'test', single_end:false ]
+  - input:
+      type: file
+      description: A pairs file
+
+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}"
+  - sorted:
+      type: file
+      description: Sorted pairs file
+      pattern: "*.{pairs.gz}"
+
+authors:
+  - "@jianhong"

tests/config/pytest_software.yml

@@ -467,6 +467,10 @@ pairtools/parse:
   - software/pairtools/parse/**
   - tests/software/pairtools/parse/**
 
+pairtools/sort:
+  - software/pairtools/sort/**
+  - tests/software/pairtools/sort/**
+
 pangolin:
   - software/pangolin/**
   - tests/software/pangolin/**

tests/software/pairtools/sort/main.nf

@@ -0,0 +1,13 @@
+#!/usr/bin/env nextflow
+
+nextflow.enable.dsl = 2
+
+include { PAIRTOOLS_SORT } from '../../../../software/pairtools/sort/main.nf' addParams( options: ['suffix':'.sorted'] )
+
+workflow test_pairtools_sort {
+
+    input = [ [ id:'test', single_end:false ], // meta map
+              file("https://raw.githubusercontent.com/open2c/pairtools/master/tests/data/mock.pairsam", checkIfExists: true) ]
+
+    PAIRTOOLS_SORT ( input )
+}

tests/software/pairtools/sort/test.yml

@@ -0,0 +1,7 @@
+- name: pairtools sort test_pairtools_sort
+  command: nextflow run tests/software/pairtools/sort -entry test_pairtools_sort -c tests/config/nextflow.config
+  tags:
+    - pairtools/sort
+    - pairtools
+  files:
+    - path: output/pairtools/test.sorted.pairs.gz