BioPAX2GPML and GPML2BioPAX

From System Biology Format Converter framework (SBFC)
Jump to: navigation, search

Conversion between BioPAX and GPML

Introduction

About BioPAX
The main objective of the BioPAX initiative is to develop a data exchange format for biological pathways that is flexible, extensible, optionally encapsulated and compatible with other standards and can be widely adopted in a timely manner.
About GPML
GPML (Graphical Pathway Markup Language) is simply an XML-based format. You can use it to define a pathway consisting of purely graphical elements (such as lines and shapes) or graphical elements with added biological information (such as genes, proteins and datanodes).


Documentation

These converters aims to translate between BioPAX model and GPML, using the pathvisio-core library. For mode details about GPML, please refer to the documentation.


Download

You can download the converters GPML2BioPAX and BioPAX2GPML and their jar dependencies here.


End users

These converters require java 1.6+. To run these converters, you have to copy all the jar files from the folder:

https://sourceforge.net/p/sbfc/code/HEAD/tree/converters/sbfc-pathvisio/lib/

to the folder SBFC_core/lib.

To test the correct installation, you can type the scripts:

    # Print the list of available converters. GPML2BioPAX and BioPAX2GPML should be printed.
    ./sbfConverterList.sh
    # Print the list of available models. GPMLModel and BioPAXOldModel should be printed.
    ./sbfModelList.sh

To run the converter, you can use the script sbfConverter.sh with the usual syntax:

    # Convert a model from BioPAX to GPML
    ./sbfConverter.sh BioPAXOldModel BioPAX2GPML [file.owl | folder]
    # Convert a model from GPML to BioPAX
    ./sbfConverter.sh GPMLModel GPML2BioPAX [file.gpml | folder]

Please note that these converters use an old version of the BioPAX tools. The model for BioPAX is called BioPAXOldModel as it uses an old library, and it should not be confused with BioPAXModel, which is the default BioPAX model in SBFC_core.


Developers

To compile the package sbfc-pathvisio from source, you also need Apache Ant 1.6.5 or higher. After editing the source code you can build the jar file by just typing in the sbfc-pathvisio folder:

    # Generate the jar file
    ant jar
    # Generate the java documentation
    ant javadoc


Getting Help and Support

In case you discover a bug within SBFC or request new features, please let us know. There are two dedicated trackers:

For general discussions about SBFC, please use the forum:

sbfc-forum [at] googlegroups.com.

If you need further support or you wish to develop new modules in SBFC you can contact the team using the following e-mail address:

sbfc-devel [at] googlegroups.com.