search

mwalzer / psi-pi

Automatically exported from code.google.com/p/psi-pi
0 stars 0 forks source link

Things to submit into DocProc #41

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Martin to clarify details of the submission process with Norman and
Christian (PSI editors).

Mandatory:
- documentation and specification document
- AnalysisXML schema (XSD format)
- FuGE light schema (XSD format)
- CV (OBO format)

Optional?:
- use cases (schema-valid)
- validator??

Original issue reported on code.google.com by eisena...@googlemail.com on 31 Jul 2008 at 4:08

GoogleCodeExporter commented 9 years ago 
I think you also need to have a document showing how MIAPE information is 
encoded in
the XML. I can help with the submission process, it's not too difficult. There 
is
kind of a standard format for the spec doc, see the mzML specs or GelML, so 
when you
start writing make sure you follow this.

Original comment by andrewro...@googlemail.com on 1 Aug 2008 at 9:18

GoogleCodeExporter commented 9 years ago 
I'm starting to wonder if we should make the *primary* documentation the wiki.
Although we'd still need to create the formal spec doc for submission, this is 
less
likely to be kept up to date long term as much as a wiki would. If we wanted to 
do
this, we should start adding pages/structure to the wiki rather than just a 
single
page of notes. Any thoughts?

Original comment by dcre...@gmail.com on 1 Aug 2008 at 9:49

GoogleCodeExporter commented 9 years ago 
updated list (considering comments and Davids Toledo slides)

Mandatory:
- use cases document (for what use cases is the format created?)
- documentation and specification document (similar to mzML)
- doc prooving MIAPE compliance
- AnalysisXML schema (XSD format)
- FuGE light schema (XSD format)
- CV (OBO format)
- example documents (schema-valid)

Optional?:
- a simple viewer
- validation tools

Always up-to-date?:
- the wiki documentation

Original comment by eisena...@googlemail.com on 4 Aug 2008 at 4:23

GoogleCodeExporter commented 9 years ago 
updated list (assigning responsibles)

Mandatory:
- use cases document (David)
- documentation and specification document (Word doc.) (Martin begins, Andy 
goes on)
- doc prooving MIAPE compliance (David)
- AnalysisXML schema (XSD format) (all, Andy)
- FuGE light schema (XSD format) (all, Andy)
- CV (OBO format) (Martin, Zsuzsanna?)
- example documents (schema-valid) (several)

Always up-to-date:
- the wiki documentation (derived from the submitted spec doc at the end)

Optional:
- a simple viewer
- validation tools

Original comment by eisena...@googlemail.com on 7 Aug 2008 at 4:02

GoogleCodeExporter commented 9 years ago 
updated list

Mandatory:
- use cases document (David)
- documentation and specification document (Word doc.) (Andy, Martin, Andreas)
- doc prooving MIAPE compliance (David)
- AnalysisXML schema (XSD format) (all, Andy)
- FuGE light schema (XSD format) (all, Andy)
- CV (OBO format) (Martin, Andreas, Zsuzsanna?)
- example documents (schema-valid) (several)

Always up-to-date:
- the wiki documentation (derived from the submitted spec doc at the end)

Optional:
- a simple viewer
- validation tools

Original comment by eisena...@googlemail.com on 5 Nov 2008 at 3:18

GoogleCodeExporter commented 9 years ago

Original comment by eisena...@googlemail.com on 22 Dec 2008 at 12:28