Skip to content

Decoupling cometconfig and update comet to nf-core version - #15

Merged
di-hardt merged 10 commits into
devfrom
update_comet_2026.01.1
Apr 2, 2026
Merged

Decoupling cometconfig and update comet to nf-core version#15
di-hardt merged 10 commits into
devfrom
update_comet_2026.01.1

Conversation

@julianu

@julianu julianu commented Mar 27, 2026

Copy link
Copy Markdown
Collaborator

This pull request introduces a new modular approach for handling Comet MS/MS search engine configuration in the workflow. The main changes include splitting the Comet parameter file generation into a dedicated COMETCONFIG process, updating related workflow and configuration files, and improving output management for both Comet and Percolator modules.

The most important changes are:

  • Comet Configuration Decoupling
  • Module and Workflow Structure Updates (added nf-core/comet)
  • some changes for Percolator and Sage

These changes make the workflow more modular, maintainable, and easier to configure for different Comet search scenarios.

@github-actions

github-actions Bot commented Mar 27, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 4d10583

+| ✅ 192 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗  26 tests had warnings |!
Details

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: TODO nf-core:
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in README.md: Fill in short bullet-pointed list of the default steps in the pipeline
  • pipeline_todos - TODO string in README.md: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
  • pipeline_todos - TODO string in README.md: update the following command to include all required parameters for a minimal example
  • pipeline_todos - TODO string in README.md: If applicable, make list of people who have also contributed
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in meta.yml: Update the information obtained from bio.tools and make sure that it is correct
  • pipeline_todos - TODO string in meta.yml: # Add a description of the module and list keywords
  • pipeline_todos - TODO string in meta.yml: #Add a description and other details for the software below
  • pipeline_todos - TODO string in meta.yml: ##Add a description of all of the variables used as input
  • pipeline_todos - TODO string in meta.yml: ##Add a description of all of the variables used as output
  • pipeline_todos - TODO string in meta.yml: ##Add a description of all of the variables used as input
  • pipeline_todos - TODO string in meta.yml: ##Add a description of all of the variables used as output
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • pipeline_todos - TODO string in output.md: Write this documentation describing your workflow's output

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-04-02 14:09:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Comet integration to version 2026.01.1 and decouples Comet parameter templating into a dedicated COMETCONFIG module, allowing a user-provided template (or bundled default) to be adjusted before running Comet.

Changes:

  • Add comet_config_template pipeline parameter and plumb it through main.nfworkflows/mspepid.nfSPECTRA_IDENTIFICATION.
  • Introduce modules/local/cometconfig to generate adjusted *.comet.params files from a template.
  • Update Comet module to consume a params file and bump Comet to 2026.01.1 (conda + container), including version-capture fixes.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
workflows/mspepid.nf Adds comet_config_template to workflow inputs and forwards it to spectra identification
subworkflows/local/spectra_identification/main.nf Wires COMETCONFIG into the Comet execution path and passes generated params to Comet
nextflow_schema.json Adds schema entry for comet_config_template
nextflow.config Adds default params.comet_config_template = null
modules/local/cometconfig/main.nf New module that copies a template and applies tolerance edits via sed
modules/local/cometconfig/environment.yml Conda env for COMETCONFIG
modules/local/comet/main.nf Updates Comet container/conda version; changes input to accept a params file
modules/local/comet/environment.yml Bumps comet-ms conda package version
modules/local/comet/meta.yml Adjusts Comet version-eval command (but docs now need updating for new inputs)
conf/modules.config Disables publishing for COMETCONFIG
assets/searchengines/comet.params Adds bundled default Comet params template
main.nf Forwards params.comet_config_template into the main workflow call
Comments suppressed due to low confidence (1)

modules/local/comet/main.nf:18

  • COMET outputs path("*.comet.params"), but the script copies the staged comet_params file to ${prefix}.comet.params when names differ. That can leave two *.comet.params files in the work dir (e.g. default.comet.params + sample.comet.params), so the output may become a list unexpectedly and break downstream usage. Emit only the intended params file (exact filename) and/or remove/rename the staged input after copying so only one match remains.
    tuple val(meta), path(mzml), path(fasta), path(comet_params)

    output:
    tuple val(meta), path("*.comet.params"), emit: params
    tuple val(meta), path("*.sqt"), emit: sqt, optional: true

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread nextflow_schema.json Outdated
Comment thread workflows/mspepid.nf
Comment thread modules/local/cometconfig/main.nf
Comment thread modules/nf-core/comet/meta.yml
@julianu julianu changed the title Update comet 2026.01.1 Decoupling cometconfig and update comet to 2026.01.1 Mar 30, 2026
@julianu julianu changed the title Decoupling cometconfig and update comet to 2026.01.1 Decoupling cometconfig and update comet to nf-core version Apr 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread nextflow_schema.json Outdated
Comment thread modules/local/cometconfig/main.nf
Comment thread modules/local/cometconfig/main.nf Outdated

@di-hardt di-hardt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works fine with and without given comet parameter file

@di-hardt
di-hardt merged commit 8958be0 into dev Apr 2, 2026
7 of 8 checks passed
@di-hardt
di-hardt deleted the update_comet_2026.01.1 branch April 2, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants