Skip to content

reactome/sbml-exporter

Repository files navigation

SBML Exporter

Code to create an SBML file from a pathway drawn from the Reactome Graph Database.

Usage

SBMLExportLauncher takes a number of arguments and outputs one or more SBML files that capture the reactions exported from Reactome.

Arguments

The following arguments are required

 -h "host"      The neo4j host for the ReactomeDB
 -b "port"      The neo4j port
 -u "user"      The neoj4 username
 -p "password"  The neo4j password
 -o "output"    The directory where output files will be written
 -t "target"    Target events to convert. Use either (1) comma separated event identifiers, (2) a given species (e.g. 'Homo sapiens') or  (3)'all' to export every pathway"

SBML

The SBML exported is SBML Level 3 Version 1 Core.

Known Limitations

These are areas that have been identified as either missing information or producing a computational model that is not completely accurate. Further work is on-going to improve both the ReactomeDB and the SBML export of these situations.

  1. Identifying the Reactome Compartment containing the Reactome PhysicalEntities that appear as SBML species in the resulting SBML model. It is not always clear from the database which Compartment is appropriate; as some PhysicalEntities list multiple Compartments to account for their possible location in different places. This issue is being addressed by the Reactome curators.
  2. There are currently no SBOTerms created for any SBML reaction. The information in the ReactomeDB is not fine-grained enough to categorise types of Reactome ReactionLikeEvents. Work is progressing to provide this information.
  3. Reactome creates some PhysicalEntities as a set of possible/probably participants in a Reaction. Currently these get encoded as a single SBML species and added as a reactant/product/modifier. This is inaccurate in terms of the intended meaning of an SBML species. Further thought is being given to how to more accurately portray this information in SBML.

Future enhancements

SBML Level 3 is developing as a modular style language that allows additional information to be added to the core model by using an SBML Level 3 Package. The Qualitative Models package could be used to represent reactions that involve Gene expression. The Multistate and Multicomponent Species package could be used to more correctly represent Reactome Complexes and their reactions.


RELEASE

Note: You must have Reactome Graph Database up and running before executing the SBMLExporter

  1. Cloning and packaging the project
git clone https://github.com/reactome/sbml-exporter.git
cd sbml-exporter
mvn clean package
  1. Generating SBML files
mkdir outputdir
java -jar target/sbml-exporter-exec.jar -h localhost -b 7474 -u user -p not4share -o outputdir
  1. Compress Homo Sapiens file for the Download Page
cd outputdir
tar -czvf all_species.3.1.sbml.tgz .
tar -czvf homo_sapiens.3.1.sbml.tgz R-HSA-*
  1. Distribute the files
  • Copy homo_sapiens.3.1.sbml.tgz and all_species.3.1.sbml.tgz to download/current

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published