Skip to content

Feature ms2rescore - #16

Merged
julianu merged 21 commits into
devfrom
feature_ms2rescore
Apr 22, 2026
Merged

Feature ms2rescore#16
julianu merged 21 commits into
devfrom
feature_ms2rescore

Conversation

@julianu

@julianu julianu commented Apr 8, 2026

Copy link
Copy Markdown
Collaborator

Implementation of MS2Rescore

@github-actions

github-actions Bot commented Apr 8, 2026

Copy link
Copy Markdown

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

Posted for pipeline commit 060c349

+| ✅ 195 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 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
  • 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 awsfulltest.yml: You can customise AWS full pipeline tests as required
  • 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 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: 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

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-04-22 08:20:52

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 adds MS2Rescore-based rescoring to the mspepid Nextflow pipeline by introducing a dedicated rescoring subworkflow and new local MS2Rescore modules, along with corresponding configuration and schema updates.

Changes:

  • Added SPECTRA_RESCORING subworkflow and wired it into the main MSPEPID workflow.
  • Introduced local MS2Rescore modules to download MS2PIP models and generate MS2Rescore-enhanced PIN files for downstream Percolator runs.
  • Added new pipeline parameters (run_ms2rescore, ms2rescore_model, ms2rescore_model_dir) to config and schema.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
workflows/mspepid.nf Hooks the new rescoring subworkflow into the main pipeline workflow.
main.nf Passes new MS2Rescore parameters into the MSPEPID workflow.
nextflow.config Adds default MS2Rescore params.
nextflow_schema.json Exposes MS2Rescore params via schema (with minor typos to fix).
subworkflows/local/spectra_identification/main.nf Removes Percolator from identification stage; adds spectrum_id_pattern metadata.
subworkflows/local/spectra_rescoring/main.nf New rescoring orchestration (Percolator and MS2Rescore+Percolator).
subworkflows/local/spectra_rescoring/tests/main.nf.test Adds a test file (currently still template / incorrect for this subworkflow).
modules/local/ms2rescore/getmodel/main.nf New module to validate/download MS2PIP model files.
modules/local/ms2rescore/getmodel/environment.yml Conda env for model download module.
modules/local/ms2rescore/runms2rescore/main.nf New module to run MS2Rescore feature generation and output a PIN.
modules/local/ms2rescore/runms2rescore/environment.yml Conda env for MS2Rescore run module.
modules/local/ms2rescore/runms2rescore/meta.yml Module metadata added (currently still placeholder BAM template).
modules/local/ms2rescore/runms2rescore/templates/ms2rescore_run_chunked.py Python runner to add MS2PIP/DeepLC features chunk-wise and write PIN + versions.
conf/modules.config Adjusts publishDir rules for Percolator and adds MS2Rescore publishDir/chunk size.
conf/base.config Adds resource overrides for MS2RESCORE_RUNMS2RESCORE.

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

Comment thread subworkflows/local/spectra_rescoring/main.nf
Comment thread subworkflows/local/spectra_rescoring/main.nf Outdated
Comment thread subworkflows/local/spectra_rescoring/main.nf Outdated
Comment thread subworkflows/local/spectra_rescoring/main.nf
Comment thread subworkflows/local/spectra_rescoring/tests/main.nf.test Outdated
Comment thread modules/local/ms2rescore/runms2rescore/meta.yml Outdated
Comment thread modules/local/ms2rescore/runms2rescore/main.nf
Comment thread modules/local/ms2rescore/getmodel/main.nf Outdated
Comment thread nextflow_schema.json Outdated
Comment thread nextflow_schema.json Outdated

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 15 out of 15 changed files in this pull request and generated 5 comments.


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

Comment thread modules/local/ms2rescore/runms2rescore/meta.yml
Comment thread modules/local/ms2rescore/runms2rescore/meta.yml Outdated
Comment thread modules/local/ms2rescore/getmodel/main.nf

@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.

For Bruker files, at least for my test file, the spectrum title is not matches correctly and ms2rescore raises and error:

ms2pip.exceptions.TitlePatternError: Spectrum title pattern .*scan=(\d+)$could not be matched to spectrum IDindex=7. Are you sure that the regex contains a capturing group?

Comment thread subworkflows/local/spectra_rescoring/main.nf Outdated
@julianu
julianu requested a review from di-hardt April 22, 2026 08:25
@julianu
julianu merged commit 57a21cd into dev Apr 22, 2026
6 of 7 checks passed
@julianu
julianu deleted the feature_ms2rescore branch April 22, 2026 11:13
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