add methurator gtestimator and plot modules

modules/nf-core/methurator/gtestimator/environment.yml

@@ -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::methurator=2.1.1"

modules/nf-core/methurator/gtestimator/main.nf

@@ -0,0 +1,45 @@
+process METHURATOR_GTESTIMATOR {
+    tag "${meta.id}"
+    label 'process_medium'
+
+    conda "${moduleDir}/environment.yml"
+    container "${workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container
+        ? 'https://depot.galaxyproject.org/singularity/methurator:2.1.1--pyhdfd78af_0'
+        : 'biocontainers/methurator:2.1.1--pyhdfd78af_0'}"
+
+    input:
+    tuple val(meta), path(bam)
+    tuple val(meta2), path(bai)
+    tuple val(meta3), path(fasta)
+
+    output:
+    tuple val(meta), path("methurator_summary.yml"), emit: summary_report
+    tuple val("${task.process}"), val('methurator'), eval("methurator --version | sed 's/.* //'"), emit: versions_methurator, topic: versions
+
+    when:
+    task.ext.when == null || task.ext.when
+
+    script:
+    def args = task.ext.args ?: ''
+    if (params.rrbs) {
+        args += '--rrbs'
+    }
+    """
+    methurator gt-estimator \\
+        ${bam} \\
+        --fasta ${fasta} \\
+        --minimum-coverage ${params.minimum_coverage} \\
+        --t-max ${params.t_max} \\
+        -@ ${task.cpus} \\
+        --outdir . \\
+        --compute_ci \\
+        ${args}
+
+    """
+
+    stub:
+    """
+    touch methurator_summary.yml
+
+    """
+}

modules/nf-core/methurator/gtestimator/meta.yml

@@ -0,0 +1,89 @@
+name: methurator_gtestimator
+description: |
+  Run estimator for DNA methylation sequencing saturation.
+keywords:
+  - rrbs
+  - BS-seq
+  - methylation
+  - 5mC
+  - methylseq
+  - bisulphite
+  - bam
+tools:
+  - methurator:
+      description: |
+        Methurator is a Python package designed to estimate CpGs saturation
+        for DNA methylation sequencing data.
+      homepage: https://github.com/VIBTOBIlab/methurator
+      documentation: https://github.com/VIBTOBIlab/methurator/README.md
+      licence:
+        - "MIT"
+      identifier: ""
+input:
+  - - meta:
+        type: map
+        description: |
+          Groovy Map containing sample information
+          e.g. [ id:'test', single_end:false ]
+    - bam:
+        type: file
+        description: BAM/CRAM file
+        pattern: "*.{bam,cram}"
+        ontologies: []
+  - - meta2:
+        type: map
+        description: |
+          Groovy Map containing sample information
+          e.g. [ id:'test', single_end:false ]
+    - bai:
+        type: file
+        description: BAM/CRAM index file
+        pattern: "*.{bai,crai}"
+        ontologies: []
+  - - meta3:
+        type: map
+        description: |
+          Groovy Map containing sample information
+          e.g. [ id:'test', single_end:false ]
+    - fasta:
+        type: file
+        description: Input genome fasta file
+        pattern: "*.{fasta,fa}"
+        ontologies: []
+output:
+  summary_report:
+    - - meta:
+          type: map
+          description: |
+            Groovy Map containing sample information
+            e.g. [ id:'test', single_end:false ]
+      - methurator_summary.yml:
+          type: file
+          description: |
+            methurator gtestimator summary report in YAML format
+          ontologies: []
+  versions_methurator:
+    - - ${task.process}:
+          type: string
+          description: methurator gtestimator
+      - methurator:
+          type: string
+          description: The name of the tool
+      - methurator --version | sed 's/.* //':
+          type: eval
+          description: The expression to obtain the version of the tool
+topics:
+  versions:
+    - - ${task.process}:
+          type: string
+          description: methurator gtestimator
+      - methurator:
+          type: string
+          description: The name of the tool
+      - methurator --version | sed 's/.* //':
+          type: eval
+          description: The expression to obtain the version of the tool
+authors:
+  - "@edogiuili"
+maintainers:
+  - "@edogiuili"

modules/nf-core/methurator/gtestimator/tests/main.nf.test

@@ -0,0 +1,78 @@
+nextflow_process {
+
+    name "Test Process METHURATOR_GTESTIMATOR"
+    script "../main.nf"
+    process "METHURATOR_GTESTIMATOR"
+
+    tag "modules"
+    tag "modules_nfcore"
+    tag "methurator"
+    tag "methurator/gtestimator"
+
+    test("Run methurator gt-estimator on paired-end methylated [bam] | sarscov2 genome [fasta]") {
+
+        when {
+            params {
+                t_max = 10
+                minimum_coverage = 1
+                rrbs = false
+            }
+            process {
+                """
+                input[0] = [ [ id:'test_bam' ],
+                               file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/bam/test.paired_end.methylated.sorted.bam', checkIfExists: true)
+                ]
+                input[1] = [ [ id:'test', single_end:false ],
+                    file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/bam/test.paired_end.methylated.sorted.bam.bai')
+                ]
+                input[2] = [ [ id: 'test_fasta' ],
+                             file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)
+                ]
+                """
+            }
+        }
+
+        then {
+            assertAll(
+                { assert process.success },
+                { assert snapshot(
+                    // Avoid first 3 lines of the summary report as they contain the date and time of the run
+                    file(process.out.summary_report[0][1]).readLines()[3..10],
+                    process.out.findAll { key, val -> key.startsWith('versions') }
+                ).match()}
+            )
+        }
+    }
+    test("Run methurator gt-estimator on paired-end methylated [bam] | sarscov2 genome [fasta] - stub") {
+
+        options "-stub"
+
+        when {
+            params {
+                minimum_coverage = 1
+                t_max = 10
+                rrbs = false
+            }
+            process {
+                """
+                input[0] = [ [ id:'test_bam' ],
+                               file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/bam/test.paired_end.methylated.sorted.bam', checkIfExists: true)
+                ]
+                input[1] = [ [ id:'test', single_end:false ],
+                    file(params.modules_testdata_base_path + 'genomics/sarscov2/illumina/bam/test.paired_end.methylated.sorted.bam.bai')
+                ]
+                input[2] = [ [ id: 'test_fasta' ],
+                             file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)
+                ]
+                """
+            }
+        }
+
+        then {
+            assertAll(
+                { assert process.success },
+                { assert snapshot(sanitizeOutput(process.out)).match() }
+            )
+        }
+    }
+}

modules/nf-core/methurator/gtestimator/tests/main.nf.test.snap

@@ -0,0 +1,56 @@
+{
+    "Run methurator gt-estimator on paired-end methylated [bam] | sarscov2 genome [fasta] - stub": {
+        "content": [
+            {
+                "summary_report": [
+                    [
+                        {
+                            "id": "test_bam"
+                        },
+                        "methurator_summary.yml:md5,d41d8cd98f00b204e9800998ecf8427e"
+                    ]
+                ],
+                "versions_methurator": [
+                    [
+                        "METHURATOR_GTESTIMATOR",
+                        "methurator",
+                        "2.1.1"
+                    ]
+                ]
+            }
+        ],
+        "timestamp": "2026-04-04T17:56:55.555845",
+        "meta": {
+            "nf-test": "0.9.5",
+            "nextflow": "25.10.0"
+        }
+    },
+    "Run methurator gt-estimator on paired-end methylated [bam] | sarscov2 genome [fasta]": {
+        "content": [
+            [
+                "    methurator_version: 2.1.1",
+                "    command: methurator gt_estimator",
+                "    options:",
+                "      cov_files:",
+                "      - ./covs/test.paired_end.methylated.sorted_CpG.bedGraph.gz",
+                "      outdir: .",
+                "      minimum_coverage: '1'",
+                "      t_step: 0.05"
+            ],
+            {
+                "versions_methurator": [
+                    [
+                        "METHURATOR_GTESTIMATOR",
+                        "methurator",
+                        "2.1.1"
+                    ]
+                ]
+            }
+        ],
+        "timestamp": "2026-04-04T17:56:48.448736",
+        "meta": {
+            "nf-test": "0.9.5",
+            "nextflow": "25.10.0"
+        }
+    }
+}

modules/nf-core/methurator/plot/environment.yml

@@ -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::methurator=2.1.1"

modules/nf-core/methurator/plot/main.nf

@@ -0,0 +1,35 @@
+process METHURATOR_PLOT {
+    tag "${meta.id}"
+    label 'process_medium'
+
+    conda "${moduleDir}/environment.yml"
+    container "${workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container
+        ? 'https://depot.galaxyproject.org/singularity/methurator:2.1.1--pyhdfd78af_0'
+        : 'biocontainers/methurator:2.1.1--pyhdfd78af_0'}"
+
+    input:
+    tuple val(meta), path(summary_report)
+
+    output:
+    tuple val(meta), path("plots/*.html"), emit: plots
+    tuple val("${task.process}"), val('methurator'), eval("methurator --version | sed 's/.* //'"), emit: versions_methurator, topic: versions
+
+    when:
+    task.ext.when == null || task.ext.when
+
+    script:
+    """
+    methurator plot \\
+        --summary ${summary_report} \\
+        --outdir .
+
+    """
+
+    stub:
+    def prefix = task.ext.prefix ?: "${meta.id}.html"
+    """
+    mkdir plots/
+    touch plots/${prefix}
+
+    """
+}

modules/nf-core/methurator/plot/meta.yml

@@ -0,0 +1,72 @@
+name: methurator_plot
+description: Plots results produced by methurator gtestimator.
+keywords:
+  - rrbs
+  - BS-seq
+  - methylation
+  - 5mC
+  - methylseq
+  - bisulphite
+  - bisulfite
+  - bam
+tools:
+  - methurator:
+      description: |
+        methurator is a Python package designed to estimate sequencing saturation
+        for DNA methylation sequencing data.
+      homepage: https://github.com/VIBTOBIlab/methurator
+      documentation: https://github.com/VIBTOBIlab/methurator/README.md
+      licence:
+        - "MIT"
+      identifier: ""
+input:
+  - - meta:
+        type: map
+        description: |
+          Groovy Map containing sample information
+          e.g. [ id:'test', single_end:false ]
+    - summary_report:
+        type: file
+        description: |
+          YAML file summarizing the saturation analysis results.
+        pattern: "methurator_*.yml"
+        ontologies:
+          - edam: http://edamontology.org/format_3750
+output:
+  plots:
+    - - meta:
+          type: map
+          description: |
+            Groovy Map containing sample information
+            e.g. [ id:'test', single_end:false ]
+      - plots/*.html:
+          type: file
+          description: |
+            HTML plots generated from the saturation analysis.
+          pattern: "plots/*.html"
+          ontologies: []
+  versions_methurator:
+    - - ${task.process}:
+          type: string
+          description: methurator plot
+      - methurator:
+          type: string
+          description: The name of the tool
+      - methurator --version | sed 's/.* //':
+          type: eval
+          description: The expression to obtain the version of the tool
+topics:
+  versions:
+    - - ${task.process}:
+          type: string
+          description: methurator plot
+      - methurator:
+          type: string
+          description: The name of the tool
+      - methurator --version | sed 's/.* //':
+          type: eval
+          description: The expression to obtain the version of the tool
+authors:
+  - "@edogiuili"
+maintainers:
+  - "@edogiuili"