Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added format mzTab-M #796

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

cb2993
Copy link

@cb2993 cb2993 commented Dec 15, 2021

Hi,
With @sneumann we have gone through some data formats in chemistry and want to add the format mzTab-m from @HUPO-PSI.

A issue #784 has already been created and herewith the corresponding PR shall be submitted.

I hope it is correct, this one is my first PR @matuskalas .
Yours, Claudia.

@sonarcloud
Copy link

sonarcloud bot commented Dec 15, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@matuskalas matuskalas self-assigned this Dec 16, 2021
@matuskalas matuskalas added the concept/term addition Request for a new concept(s), or change(s) to existing concept(s) label Dec 16, 2021
@matuskalas matuskalas self-requested a review December 16, 2021 00:08
@matuskalas matuskalas added this to In progress in release 1.26 via automation Dec 16, 2021
@matuskalas matuskalas added this to the 1.26 milestone Dec 16, 2021
@matuskalas matuskalas linked an issue Dec 16, 2021 that may be closed by this pull request
Copy link
Member

@matuskalas matuskalas left a comment

Choose a reason for hiding this comment

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

Thank you so much Claudia for your pull request, and a warm welcome among the EDAM contributors! 😊🙌🏽
Honestly, this is the absolutely cleanest first-time contribution in the history of EDAM 🥇 Highly appreciated! 🙏🏽

TODO: I'll merge it asap, and at the same time I'll assign it the ID and check all the links. So as far as I can see, the only TODO is on me. 😉 But I'll ask in case anything turns out unclear. Maybe 1 immediate question to double-check the compatibility: Is any valid mzTab-M-formatted data also valid as mzTab?

I hope you'll have a chance to contribute more in the future! 🦑 Please feel free to ask if you have any questions related to that.
You're also welcome to join the EDAM community chat, which at the very moment has zero traffic, but that should change in the future 😄 You're super welcome to ask any public questions there, anytime! This all applies to you @sneumann too!😊

We would love to add you onto the list of co-authors @cb2993, so if you don't mind being listed, please send me your author details (especially name). You're very welcome to do that privately using my university email, and we will NOT publicly associate your personal info with your GitHub account. Any privacy concerns are welcome👍🏽

Many thanks again,
Matus

release 1.26 automation moved this from In progress to Review in progress Dec 16, 2021
@sneumann
Copy link

HI @matuskalas,
no, after mzTab (1.0) the mzTab-M 2.0 has diverged, and is not compatible anymore. General concepts remain, but parsers (beyond set of CSVs) will not be compatible. And yes, happy to be listed as contributor. Yours, STeffen

Copy link
Member

@matuskalas matuskalas left a comment

Choose a reason for hiding this comment

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

This is awesome👍🏽 we can merge it and fix the ID (rdf:about..) right before the merge

release 1.26 automation moved this from Review in progress to Reviewer approved Feb 3, 2022
@LucieLamothe
Copy link
Collaborator

Hi @cb2993 @sneumann, when you say that the two format are not compatible what do you mean exactly? For example the tools are they able to read both file? Is the conversion from one the the other is easily doable? I'm asking this so we can determine whether to have mzTab-M as subclass of the existing format mzTab or as "brother" of mzTab (both subclass of Mass spectrometry data format).

Thank you so much for yor help :)

Lucie L

@sneumann
Copy link

sneumann commented Feb 9, 2022

Hm, @nilshoffmann might be able to chime in. MzTab 1.0 and the mzTab-* 2.0 formats will both be readable by CSV readers ;-) Both have a Metadata section that should be compatible. Readers for 1.0 will choke (or ignore) on the actual data in mzTab-M 2.0. It is not likely that a reader for 2.0 faithfully consumes 1.0 files. I would expect that a software would have two readers, and detect file version to decide which reader to call.
Was that helpful ? Yours, Steffen
P.S.: Technically I'd say mzTab-M should be a sibling to mzTab-1.0 , historically it'd be a child.

@nilshoffmann
Copy link

@LucieLamothe @sneumann The mzTab-M format comes with separate parser and validator implementations. Generic CSV readers may read both formats, but the metadata sections and specifically the content sections are not compatible, although they share some structure. Conversion from mzTab to mzTab-M would be possible, but only on summary level. The other way around may be possible, but only with loss of information. I would therefor also see mzTab-M more as a sibling and "brother in spirit".

@matuskalas
Copy link
Member

Thanks a lot for the clarifications @sneumann & @nilshoffmann 🙏🏽

@matuskalas
Copy link
Member

Million thanks indeed 🙇🏽‍♂️ I think this is rather clear now.

One note from the live chat: Just like ISA-TAB, mzTab-M can use any ontologies inside. PSI-MS is the main and most obvious, and some other main ones are listed in https://github.com/HUPO-PSI/mzTab/blob/master/specification_document-releases/2_0-Metabolomics-Release/mzTab_2_0-M_mapping.xml. However, any other can be used, too.

@nilshoffmann
Copy link

@matuskalas Is there anything that we need to change / update to get this PR merged?

@nilshoffmann
Copy link

Pinging @matuskalas to kindly ask to proceed with the merging of mzTab-M

@nilshoffmann
Copy link

And pinging @matuskalas again to kindly ask to proceed with the merging of mzTab-M. Not sure why the CI build failed, the logs are no longer available.

@hechth
Copy link

hechth commented Oct 5, 2023

@matuskalas I'd also like to ask if this could be added? Would be great! Thanks!

@nilshoffmann
Copy link

@matuskalas @LucieLamothe What is the status of this PR? Is there a timeline when it might be merged?

@LucieLamothe
Copy link
Collaborator

I left this project last year I'm sorry I won't be able to help :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
concept/term addition Request for a new concept(s), or change(s) to existing concept(s)
Projects
release 1.26
Reviewer approved
Development

Successfully merging this pull request may close these issues.

New format mzTab-M
6 participants