RGLab / CytoML

A GatingML Interface for Cross Platform Cytometry Data Sharing
GNU Affero General Public License v3.0
29 stars 14 forks source link

Adding new CytoML XSD #74

Closed whitews closed 4 years ago

whitews commented 4 years ago

Here is the XSD document for validating the XML output generated by CytoML. It is basically a modification of the GatingML 2.0 XSD. I noticed the Gating ML XSD had a copyright and was released as "read only", so I contacted Josef Spidlen. I had previously contacted him regarding GatingML support in my FlowKit library. He was very supportive and replied that we can consider the GatingML XSD as under the Creative Commons license and are free to modify and distribute this publicly.

I put the XSD in a new "schema" directory. I also thought of putting it in a separate "schema" branch but felt that would make it harder to find. I've also named it CytoML instead of referencing Cytobank since we don't know what changes they might make to their format in the future.

What remains now is to modify the XSD reference in the output XML, which I will do once this PR is accepted and the XSD is publicly available. We'll need to know the exact URL to get the raw file from this Github repo. I think it will be something like:

https://raw.githubusercontent.com/RGLab/CytoML/trunk/schema/CytoML.v1.0.xsd

After that, I will add CytoML support in FlowKit so users will have options in R and Python for this new format. Let me know if you have any questions or have any requests to modify this PR.

Thanks, Scott

mikejiang commented 4 years ago

I moved the folder

schema/CytoML.v1.0.xsd -> inst/schema/CytoML.v1.0.xsd