Skip to content

Added mzspeclib convert & describe tools#682

Merged
hechth merged 13 commits intomasterfrom
hechth/issue668
Jun 30, 2025
Merged

Added mzspeclib convert & describe tools#682
hechth merged 13 commits intomasterfrom
hechth/issue668

Conversation

@hechth
Copy link
Copy Markdown
Member

@hechth hechth commented Jun 12, 2025

Added tool wrappers to validate and convert libraries to mzspeclib format.

Closes #668

The mzSpecLib validate tool is postponed until HUPO-PSI/mzspeclib-py#5 is merged and we have a new release 1.0.7

@hechth hechth changed the title Added mzspeclib convert & validate tools Added mzspeclib convert & describe tools Jun 12, 2025
@hechth hechth requested review from acquayefrank and bgruening June 12, 2025 14:10
@acquayefrank acquayefrank requested a review from Copilot June 18, 2025 14:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds Galaxy tool wrappers for converting and describing mass spectral libraries in the mzspeclib format.

  • Introduces sample test data for MSP and mzspeclib text formats, plus an expected describe report.
  • Provides mzspeclib_convert.xml and mzspeclib_describe.xml with commands, inputs, outputs, tests, and help.
  • Updates version macros (macros.xml) and suite metadata (.shed.yml).

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/mzspeclib/test-data/sample_describe_report.txt Sample output used in describe tool test
tools/mzspeclib/test-data/sample.txt Sample mzspeclib text-format library
tools/mzspeclib/test-data/sample.msp Sample MSP-format library
tools/mzspeclib/mzspeclib_describe.xml Galaxy wrapper for mzspeclib describe
tools/mzspeclib/mzspeclib_convert.xml Galaxy wrapper for mzspeclib convert
tools/mzspeclib/macros.xml Defines @TOOL_VERSION@ and creator/citation macros
tools/mzspeclib/.shed.yml Suite metadata for Galaxy Tool Shed
Comments suppressed due to low confidence (3)

tools/mzspeclib/mzspeclib_describe.xml:14

  • The -i flag here appears to pass a prefixed filename (mzspeclib.${input.ext}) rather than the intended input format (e.g., txt or json). Consider changing to -i ${input.ext} so that the CLI correctly interprets the input format.
    mzspeclib describe -i mzspeclib.${input.ext} ${input} > ${output}

tools/mzspeclib/mzspeclib_convert.xml:14

  • The argument order may not align with mzspeclib convert syntax, which typically expects the input file immediately after the command. Verify the CLI usage and consider reordering to mzspeclib convert ${input} -i ${input.ext} -f text ${output}.
    mzspeclib convert -i ${input.ext} -f text ${input} ${output}

tools/mzspeclib/.shed.yml:1

  • [nitpick] For consistency with the official project branding (mzSpecLib), consider updating occurrences of mzspeclib in the suite metadata (e.g., name, description) to use the canonical capitalization.
name: mzspeclib

@acquayefrank
Copy link
Copy Markdown
Collaborator

@hechth looks good to me

@hechth hechth merged commit 6707579 into master Jun 30, 2025
12 checks passed
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.

mzspeclib: conversion tool

3 participants