Skip to content

Commit

Permalink
Initial addition
Browse files Browse the repository at this point in the history
  • Loading branch information
ramirobarrantes committed Dec 3, 2024
1 parent 2cc745f commit 557870d
Show file tree
Hide file tree
Showing 5 changed files with 251 additions and 0 deletions.
7 changes: 7 additions & 0 deletions modules/nf-core/coptr/estimate/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/environment-schema.json
channels:
- conda-forge
- bioconda
dependencies:
- "bioconda::coptr=1.1.4"
49 changes: 49 additions & 0 deletions modules/nf-core/coptr/estimate/main.nf
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
process COPTR_ESTIMATE {
tag "$meta.id"
label 'process_low'

conda "${moduleDir}/environment.yml"
container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
'https://depot.galaxyproject.org/singularity/coptr:1.1.4--pyhdfd78af_3':
'biocontainers/coptr:1.1.4--pyhdfd78af_3' }"

input:
tuple val(meta), path(pkl, stageAs: "coverage_maps/*")

output:
tuple val(meta), path("*.csv"), emit: ptr
path "versions.yml" , emit: versions

when:
task.ext.when == null || task.ext.when

script:
def args = task.ext.args ?: ''
def prefix = task.ext.prefix ?: "${meta.id}"

"""
coptr \\
estimate \\
$args \\
coverage_maps/ \\
ptrs.csv
cat <<-END_VERSIONS > versions.yml
"${task.process}":
coptr: \$(coptr |& sed -E '11!d ; s/CoPTR.*?\\(v(.*?)\\).*/\\1/')
END_VERSIONS
"""

stub:
def args = task.ext.args ?: ''
def prefix = task.ext.prefix ?: "${meta.id}"
"""
touch ${prefix}.csv
cat <<-END_VERSIONS > versions.yml
"${task.process}":
"${task.process}":
coptr: \$(coptr |& sed -E '11!d ; s/CoPTR.*?\\(v(.*?)\\).*/\\1/')
END_VERSIONS
"""
}
56 changes: 56 additions & 0 deletions modules/nf-core/coptr/estimate/meta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/meta-schema.json
name: "coptr_estimate"
description: Calculates peak-to-through ratio (PTR) from metagenomic sequence data
keywords:
- coptr
- mapping
- ptr
tools:
- "coptr":
description: "Accurate and robust inference of microbial growth dynamics from
metagenomic sequencing reads."
homepage: "https://github.com/tyjo/coptr"
documentation: "https://coptr.readthedocs.io/"
tool_dev_url: "https://github.com/tyjo/coptr"
doi: "10.1101/gr.275533.121"
licence: ["GPL v3"]
identifier: biotools:coptr

input:
- - meta:
type: map
description: |
Groovy Map containing sample information
e.g. `[ id:'sample1', single_end:false ]`
- pkl:
type: file
description: Python pickle file containing coverage maps
pattern: "*.{.pkl}"
ontologies:
- edam: "http://edamontology.org/format_4002"

output:
- ptr:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. `[ id:'sample1', single_end:false ]`
- "*.csv":
type: file
description: CSV table with rows as reference genomes, columns samples and entries as log2 PTR
pattern: "*.{.csv}"
ontologies:
- edam: "http://edamontology.org/format_3752"

- versions:
- "versions.yml":
type: file
description: File containing software versions
pattern: "versions.yml"

authors:
- "@ramirobarrantes"
maintainers:
- "@ramirobarrantes"
71 changes: 71 additions & 0 deletions modules/nf-core/coptr/estimate/tests/main.nf.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
nextflow_process {

name "Test Process COPTR_ESTIMATE"
script "../main.nf"
process "COPTR_ESTIMATE"

tag "modules"
tag "modules_nfcore"
tag "coptr"
tag "coptr/extract"
tag "coptr/estimate"

setup {
run("COPTR_EXTRACT") {
script "../../extract/main.nf"
process {
"""
input[0] = [
[id:'test_0'],
[ file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/bam/test.paired_end.sorted.bam', checkIfExists: true)
]
]
"""
}
}
}

test("coptr estimate from coverage maps file") {

when {
process {
"""
input[0] = COPTR_EXTRACT.out.coverage
"""
}
}

then {
assertAll(
{ assert process.success },
{ assert snapshot(process.out).match()
}
)
}

}

test("coptr estimate from coverage maps file - stub") {

options "-stub"

when {
process {
"""
input[0] = COPTR_EXTRACT.out.coverage
"""
}
}

then {
assertAll(
{ assert process.success },
{ assert snapshot(process.out).match()
}
)
}

}


}
68 changes: 68 additions & 0 deletions modules/nf-core/coptr/estimate/tests/main.nf.test.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"coptr estimate from coverage maps file - stub": {
"content": [
{
"0": [
[
{
"id": "test_0"
},
"test_0.csv:md5,d41d8cd98f00b204e9800998ecf8427e"
]
],
"1": [
"versions.yml:md5,705597adb5ba701539c265f756968415"
],
"ptr": [
[
{
"id": "test_0"
},
"test_0.csv:md5,d41d8cd98f00b204e9800998ecf8427e"
]
],
"versions": [
"versions.yml:md5,705597adb5ba701539c265f756968415"
]
}
],
"meta": {
"nf-test": "0.9.2",
"nextflow": "24.10.2"
},
"timestamp": "2024-12-03T12:24:23.001351"
},
"coptr estimate from coverage maps file": {
"content": [
{
"0": [
[
{
"id": "test_0"
},
"ptrs.csv:md5,e94546e830fd9fdcd50e0e6c459f78e5"
]
],
"1": [
"versions.yml:md5,5400eb14b9d1287f174065acd6c0c6a4"
],
"ptr": [
[
{
"id": "test_0"
},
"ptrs.csv:md5,e94546e830fd9fdcd50e0e6c459f78e5"
]
],
"versions": [
"versions.yml:md5,5400eb14b9d1287f174065acd6c0c6a4"
]
}
],
"meta": {
"nf-test": "0.9.2",
"nextflow": "24.10.2"
},
"timestamp": "2024-11-29T18:28:40.680244"
}
}

0 comments on commit 557870d

Please sign in to comment.