Molecular Interaction XML Format Documentation
Released 2005, Last maintenance update to version 2.5.4
Available for use now, estimated formal release - Spring 2016
Table of Contents
- Purpose of the PSI-MI XML format
- Purpose of this document
- Directory structure
- Release schedule
- Changes from PSI-MI 1.0 to 2.5
- Maintenance releases
- Detailed Documentation
- Use of external controlled vocabularies
- List of planned features
- How to comment
- Available data
- Data submission
- Further information and relevant links
The Proteomics Standards Initiative (PSI) aims to define community standards for data representation in proteomics to facilitate data comparison, exchange and verification. For detailed information on all PSI activities, please see PSI Home Page.
The PSI-MI interchange format and accompanying controlled vocabularies was originally designed by a consortium of molecular interaction data providers from both academia and industry, including BIND, DIP, IntAct, MINT, MIPS, GlaxoSmithKline, CellZome, Hybrigenics, Universities of Bielefeld, Bordeaux, Cambridge, and others. It is maintained, and kept fit for purpose by the Molecular Interaction workgroup of the HUPO PSI. Please contact us on firstname.lastname@example.org if you wish to become involved or have any questions.
Purpose of the PSI MI XML format
The PSI MI format is a data exchange format for molecular interactions. It is not a proposed database structure.
Purpose of this document
The purpose of this document is to describe the general structure of the PSI MI XML specification in a more user-friendly manner than the specification does itself. For the detailed and most up-to-date description of PSI-MI XML2.5 please see the molecular interaction data exchange format, level 2.5. For the publication describing the development and use of this format, please look here. For documentation of the previous level 1.0 please see Version 1.0 Documentation. For level 3.0 please go to Version 3.0 documentation. This documentation will also provide additional information, e.g. sample data.
The XML schema is located at https://rawgit.com/MICommunity/psidev/master/psi/mi/rel25/doc/MIF254.html
This document is in the root directory of the PSI-MI XML2.5 release. Subdirectories are
doc/Auto-generated documentation of the PSI-MI XML schema
src/Source code for schema and related software
tools/Data management tools
- Level 3.0 will be published in 2016.
- Level 2.5 was released 5 December 2005. It is the format most commonly supported by PSI-compliant databases and tools. It will continue to be supported by the MI workgroup after the publication of PSI-MI XML3.0.
- Level 1.0 support was discontinued in 2007.
Changes from PSI-MI XML1.0 to 2.5
Changes in the PSI-MI XML format and controlled vocabularies from version 1.0 to 2.5 are documented in this page.
PSI-MI XML2.5 Maintenance releases
Minor change to header
Minor updates as a result of the PSI spring meeting in San Francisco, April 2006:
- updated entrySet@minorVersion to 3
- bioSourceType@taxId now mandatory. This was inadvertedly made non-mandatory with 2.5.2.
- featuretype@id now mandatory. This was inadvertedly made non-mandatory with 2.5.2.
- Optional attribute parameter/uncertainty added.
- Added participant/parameterList and participant/attributeList to allow more complex modelling of participants.
- Deleted XML constraints on entry level. They were not working due to syntax errors, and few XML validators can check them. This validation level will be performed by the PSI XML validator in the future.
There were some inconsistencies in the naming of complex types in 2.5.1. These have been fixed. This has no impact on the XML data files. The only impact for users is a facilitation if they use code generators. Concrete changes:
- complex type interactorType to interactorElementType
- complex type interactionType to interactionElementType
- complex type featureType to featureElementType
- featureType@id has been moved into the complex type featureElementType and typed as xs:int
- bioSourceType@ncbiTaxId has been moved into the complex type bioSourceType and typed as xs:int
- updated entrySet@minorVersion to 2
At the PSI meeting in Geneva, September 2005, it was discussed that participant/experimentalFormList/experimentalForm should have the possibility to assign a position, e.g. to describe an n-terminal protein modification in an experiment. It was decided to implement this using the existing featureType. The controlled vocabulary has been updated accordingly, but the change in the XML schema was not implemented. This required the maintenance release 2.5.1, with the following changes:
Use of external controlled vocabularies
Where possible, external controlled vocabularies are referenced from PSI MI. External controlled vocabularies are used in two forms:
- Open controlled vocabularies: We think that no existing controlled vocabulary provides all necessary terms for the given attribute in the PSI MI format. In this case, it is up to the data provider to choose a controlled vocabulary, or to provide a free text string if no appropriate controlled vocabulary exists.
- Closed controlled vocabularies: We think that there is a controlled vocabulary which appropriately covers all necessary terms for the given attribute. In this case, only terms from the defined vocabulary should be used.
The closed controlled vocabularies referenced by PSI MI are listed in the table below. All vocabularies are contained in a files in OBO flat file format: psi-mi25.obo. They can be browsed at the EBI OLS (Open Lookup Service). The correctness of references to external controlled vocabularies is currently not enforced by the PSI MI schema. It is the responsibility of the data provider to ensure that only existing terms at an up-to-date data source are referenced.
PSI MI XML schema elements and OBO major terms
PSI MI XML level 2.5 data element
participant identification method
interaction detection method
feature detection method
feature range status
The OBO format has a special class “obsolete”, to which all obsolete PSI MI terms are assigned.
Mapping from OBO to MIF25 format
We recommend the following mapping from the file psi-mi25.obo to PSI MI 2.5 XML files:
OBO format element
PSI MI 2.5 XML file element
Because we are following a leveled approach, we are interested in knowing what the community wishes to be included in the next level. If you have a use case not covered by the current schema or controlled vocabulary terms, please contact us at email@example.com.
We strongly support and encourage data deposition supporting published journal articles in public databases of the IMEx consortium. Please see the IMEx deposition page
for contact details and deposition options
Sandra Orchard, firstname.lastname@example.org, 11-DEC-2015