Skip to content

implement sage identification - #13

Merged
julianu merged 18 commits into
devfrom
feature-sage
Mar 17, 2026
Merged

implement sage identification#13
julianu merged 18 commits into
devfrom
feature-sage

Conversation

@di-hardt

Copy link
Copy Markdown
Contributor

No description provided.

@di-hardt
di-hardt requested a review from julianu March 13, 2026 15:51
@github-actions

github-actions Bot commented Mar 13, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Failed ❌

Posted for pipeline commit bdb32e8

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

❌ Test failures:

  • nextflow_config - Config default value incorrect: params.sage_config_template is set as `` in nextflow_schema.json but is `null` in `nextflow.config`.

❗ 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 awsfulltest.yml: You can customise AWS full pipeline tests as required
  • 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 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 meta.yml: Update the information obtained from bio.tools and make sure that it is correct
  • 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!

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-03-17 09:39:30

@julianu julianu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please fix the small issues.

Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread modules/local/sageconfig/meta.yml Outdated
Comment thread modules/local/sageconfig/meta.yml 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

Adds Sage as an additional spectrum identification engine to the nf-core/mspepid pipeline, wiring new parameters through the main workflow and introducing local modules to generate a Sage config and run Sage.

Changes:

  • Add run_sage and Sage-specific parameters (config template + optional prefiltering) across config, schema, and workflows.
  • Introduce new local modules SAGECONFIG (config adjustment) and SAGEBETA (Sage search execution) and integrate them into SPECTRA_IDENTIFICATION.
  • Add a default Sage JSON config template under assets/.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
workflows/mspepid.nf Plumbs Sage parameters through the main MSPEPID workflow into the spectra identification subworkflow.
subworkflows/local/spectra_identification/main.nf Integrates SAGECONFIG + SAGEBETA into the identification stage and mixes Sage outputs into downstream conversion.
nextflow_schema.json Adds schema definitions for Sage parameters and a run_sage toggle.
nextflow.config Adds default Sage params and enables Sage by default.
modules/local/sageconfig/meta.yml New module metadata for Sage config adjustment.
modules/local/sageconfig/main.nf New process to generate an adjusted Sage config JSON based on tolerances/prefilter params.
modules/local/sagebeta/meta.yml New module metadata for Sage execution.
modules/local/sagebeta/main.nf New process to run Sage (beta image) and emit results + version info.
main.nf Sets default Sage config template path and passes Sage args into MSPEPID.
assets/default.sage.json Provides a default Sage configuration template used when none is supplied.

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

You can also share your feedback on Copilot code review. Take the survey.

Comment thread modules/local/sagebeta/main.nf Outdated
Comment thread nextflow_schema.json Outdated
Comment thread modules/local/sageconfig/main.nf
Comment thread modules/local/sagebeta/meta.yml
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread subworkflows/local/spectra_identification/main.nf Outdated
Comment thread modules/local/sageconfig/meta.yml Outdated
Comment thread modules/local/sageconfig/main.nf Outdated
Comment thread modules/local/sagebeta/meta.yml
Comment thread modules/local/sagebeta/meta.yml
di-hardt and others added 13 commits March 16, 2026 15:26
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

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

Adds Sage as an additional search engine to the MSPEPID Nextflow pipeline, wiring new parameters through the main workflow into the spectra identification subworkflow and introducing local modules to generate a Sage config and run Sage.

Changes:

  • Add run_sage and Sage-specific parameters (sage_config_template, sage_prefilter*) to the workflow inputs, defaults, and schema.
  • Implement Sage execution path in SPECTRA_IDENTIFICATION using new SAGECONFIG and SAGEBETA modules.
  • Add a bundled default Sage JSON template and module publish configuration for Sage outputs.

Reviewed changes

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

Show a summary per file
File Description
workflows/mspepid.nf Plumbs Sage flags/params into the main MSPEPID workflow call to spectra identification.
subworkflows/local/spectra_identification/main.nf Conditionally runs Sage (config generation + search) and mixes results into the identification stream.
nextflow_schema.json Adds schema entries for run_sage and Sage search parameters.
nextflow.config Defines default values for the new Sage parameters.
modules/local/sageconfig/meta.yml Adds nf-core module metadata for Sage config adjustment (has output-key issues).
modules/local/sageconfig/main.nf New process to adjust a Sage config JSON based on tolerances/prefilter params.
modules/local/sagebeta/meta.yml Adds nf-core module metadata for running Sage (has output-key issues + a typo).
modules/local/sagebeta/main.nf New process to run Sage and emit result artifacts + version info.
main.nf Passes new Sage params into the MSPEPID workflow.
conf/modules.config Configures publish behavior for Sage outputs and disables publishing for the intermediate config module.
assets/searchengines/default.sage.json Adds a default Sage configuration template used when no custom template is provided.

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

You can also share your feedback on Copilot code review. Take the survey.

Comment thread modules/local/sageconfig/meta.yml
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread modules/local/sagebeta/meta.yml Outdated
Comment thread nextflow_schema.json
@julianu
julianu merged commit 88a1c5a into dev Mar 17, 2026
5 of 7 checks passed
@julianu
julianu deleted the feature-sage branch March 17, 2026 13:39
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