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

Reorganize repository #106

Merged
merged 9 commits into from
Nov 18, 2020
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed 20200326-mzQC-logo.png
Binary file not shown.
49 changes: 16 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,18 @@
# Welcome to the PSI-QC working group repository.
[![Build Status](https://travis-ci.org/HUPO-PSI/mzQC.svg?branch=master)](https://travis-ci.org/HUPO-PSI/mzQC)
======

## 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.
# mzQC: A standard file format for mass spectrometry quality control data

[![Build status](https://travis-ci.org/HUPO-PSI/mzQC.svg?branch=master)](https://travis-ci.org/HUPO-PSI/mzQC)

![mzQC](mzQC.png)
bittremieux marked this conversation as resolved.
Show resolved Hide resolved

## The HUPO-PSI Quality Control working group

The HUPO PSI Quality Control working group is composed of academic, government, and industry researchers, software developers, journal representatives, and instrument manufacturers. The main goal of the 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 QC working group are:

- mzQC: A standard file format for the exchange, transmission, and archiving of quality control metrics derived from biological mass spectrometry.
- QC-CV: A controlled vocabulary to represent terms for the definition of quality metrics and related supporting values.

bittremieux marked this conversation as resolved.
Show resolved Hide resolved
## 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](https://github.com/HUPO-PSI/qcML-development/wiki/Our-GitHub-workflow)).

The easiest way to contribute is by filing an issue via GitHub.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

2 changes: 0 additions & 2 deletions legacy/pipelines/data/input/additional_tabular_data.csv

This file was deleted.

2 changes: 0 additions & 2 deletions legacy/pipelines/data/input/additional_tabular_mapping.csv

This file was deleted.

29,872 changes: 0 additions & 29,872 deletions legacy/pipelines/data/input/ecoli.fasta

This file was deleted.

Loading