Git Product home page Git Product logo

mzqc's Introduction

Welcome to the PSI-QC working group repository.

Build Status

Focus and Purpose of the working group

The PSI-QC working group is composed of academic, government, and industry researchers, software developers, journal representatives, and instrument manufacturers. The main goal of the PSI-QC working group is to define a community data format and associated controlled vocabulary terms, facilitating data exchange and archiving of mass spectrometry derived quality control metrics. Current projects of the PSI-QC working group are:

  • The qcML format, which has been developed as a standardized format for the exchange, transmission, and archiving of quality control metrics derived from mass spectrometry.
  • Controlled Vocabulary development: controlled vocabulary terms are developed in common with the PSI-MS and PSI-PI groups.

The Repository

The repository facilitates the collaborative work

Structure of the repository

Folder structure is organized by function. There are three main development folders for:

  • The Schema development
  • The CV development
  • The Specification Document development In addition, there are folders for deprecated stuff and advanced documentation.

Schema development

This folders substructure is by version. Each version should contain the following:

  • Its folder name corresponding to the version
  • The schema XSD file
  • A folder for images to be contained in the documentation process (e.g. schema visualisation)
  • A folder for examples qcML files

Specification Document development

This folder should contain the text files containing the Specification Document content. These should be plain text files with Markdown. Markdown can be easily edited and formatted with a plethora of tools, not least with the GitHub built in editor. Markdown is easily converted to .pdf, .docx, etc. Most importantly it allows content version control and GitHub rendering.

CV development

This folder should contain a OBO file with the representation of QC metrics. The file shall be hierarchically structured and in plain text. Additionally, there should be a documentation file, with detailed explanation of the cv terms, examples, visualizations and/or script snippets to calculate the metrics.

Contribute

You are welcome to contribute. The easiest way is to file an issue within GitHub. If you want to propose changes, follow the Git workflow (described here).

mzqc's People

Contributors

mwalzer avatar bittremieux avatar julianu avatar dtabb73 avatar espona avatar cbielow avatar eisenachm avatar c-schroeder avatar pkelchte avatar marc-sturm avatar rsalek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.