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

Update examples to mzQC v1.0 #225

Open
5 of 7 tasks
bittremieux opened this issue Jun 26, 2024 · 2 comments · Fixed by #219, #228, #229 or #231 · May be fixed by #233
Open
5 of 7 tasks

Update examples to mzQC v1.0 #225

bittremieux opened this issue Jun 26, 2024 · 2 comments · Fixed by #219, #228, #229 or #231 · May be fixed by #233
Labels

Comments

@bittremieux
Copy link
Collaborator

bittremieux commented Jun 26, 2024

We need to make sure that the examples on the website are fully complaint with the official mzQC v1.0 specification.

Examples to update:

New examples to add:

  • Interoperability between SDRF and mzQC

Procedure to ensure that the examples are valid:

  • The full mzQC file successfully passes validation with our validator.
  • The mzQC snippets in the corresponding markdown file are updated accordingly.
  • The description in the markdown file is accurate and informative.

Nice to have:

  • Pretty format the mzQC JSON content (indentation 2 spaces).
  • Format the markdown page to have each sentence start on a new line (for convenient git diffs)
@mwalzer
Copy link
Collaborator

mwalzer commented Jun 26, 2024

@mwalzer TLC for open (old) PRs

@mwalzer
Copy link
Collaborator

mwalzer commented Jul 23, 2024

I made some updates to the pymzqc lib that might be helpful to this and future issues of the type:

  • You can now easily call the local validator via mzqc-validator,
  • You can fix missing descriptions to (otherwise valid) mzQC skeletons - this will also do prettyprint indentation
    see also @readthedocs
    Install via:
    pip install -U git+https://github.com/MS-Quality-hub/pymzqc.git#v1.0.0rc3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment