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.

Sign up for GitHub

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

Jump to bottom

adding optional fields in schema #110

Merged
merged 11 commits into from
Dec 13, 2020
Merged

adding optional fields in schema #110

merged 11 commits into from
Dec 13, 2020

Conversation

mwalzer
Copy link
Collaborator

@mwalzer mwalzer commented Dec 3, 2020 •
edited
Loading

  • on top-level: readMe, contanctName, contactAddress
  • metadata: labelName

@mwalzer
added 3 new optional fields to schema
b92899e 
* contactName/Address, because it is good practice to have. Esp. for the store and archive use case.  (And most other PSI formats have a contact field btw.)
* labelName, because in settings with multiple setQualities we need a group identifier that also lends itself to axis labels in a plot. (And it does not hurt to have that for runs, too)
@mwalzer mwalzer changed the title adding readMe comment filed on top-level of schema adding optional fileds in schema Dec 4, 2020
@mwalzer mwalzer changed the title adding optional fileds in schema adding optional fields in schema Dec 4, 2020
cbielow
cbielow reviewed Dec 4, 2020
View reviewed changes
schema/mzqc_schema.json Outdated Show resolved Hide resolved
cbielow
cbielow reviewed Dec 4, 2020
View reviewed changes
schema/mzqc_schema.json Outdated Show resolved Hide resolved
bittremieux
bittremieux reviewed Dec 7, 2020
View reviewed changes
Copy link
Collaborator

@bittremieux bittremieux left a comment

Choose a reason for hiding this comment

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

I just have some minor naming comments.

I remember that we had contact information in a qcML version way back. Apparently, just like comments, those didn't survive the transition. I don't remember why not though.

schema/mzqc_schema.json Outdated Show resolved Hide resolved
schema/mzqc_schema.json Show resolved Hide resolved
@mwalzer mwalzer marked this pull request as ready for review December 8, 2020 17:36
@bittremieux
Copy link
Collaborator

bittremieux commented Dec 11, 2020 •
edited by mwalzer
Loading

TODO:

  • Remove fileProvenance.
  • Make sure the examples use label instead of labelName.

@mwalzer
removed fileProperties
63be081 
as discussed, virtually all purposes will be taken over by the label and description tags
@mwalzer
added examples and markdown files for these examples
20fc1cf 
also moved schema figure pptx to figures folder
@mwalzer
added doc folder readme
20c7d51
@mwalzer
updated schema figure and bumped version to v1.0
5c63788 
moved figure and pptx from doc to schema folder, too
@mwalzer
Updated markdown figures
57a9676
@mwalzer
Copy link
Collaborator Author

mwalzer commented Dec 13, 2020

takes care of #11 with up-to-date examples in v1.0

@mwalzer mwalzer merged commit 3b98add into master Dec 13, 2020
@bittremieux bittremieux deleted the readMe-field-addition branch December 16, 2020 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cbielow cbielow cbielow left review comments

@bittremieux bittremieux bittremieux left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@mwalzer @bittremieux @cbielow