reaction-exporter's Introduction

Reaction exporter

Creates diagram files out of single reactions, using the graph database as resource.

Taking a single reaction, this library performs 3 steps:

queries the graph database to retrieve the reaction, its participants and the compartments containing them.
applies an automatic layout to show a left to right view of the reaction, while keeping every participant in its compartment.
generates a diagram (.json) and a graph (.graph.json) files following Reactome specifications.

Usage:

This project can be used as a standalone compiled tool through the provided reaction-exporter.jar file.

java -jar reaction-exporter.jar [--help] [(-h|--host) <host>] [(-p|--port) <port>] [(-u|--user) <user>] (-d|--password) <password> (-s|--stId) <stId> (-o|--path) <path> [(-f|--format) <format>]
  [--help]
        Prints this help message.

  [(-h|--host) <host>]
        The neo4j host (default: localhost)
  [(-p|--port) <port>]
        The neo4j port (default: 7474)
  [(-u|--user) <user>]
        The neo4j user (default: neo4j)
  (-d|--password) <password>
        The neo4j password (default: neo4j)

  (-s|--stId) <stId>
        Reaction stable identifier

  (-o|--path) <path>
        Output path. File will be named 'path'/'stId'.'format'

  [(-f|--format) <format>]
        Output format (default: png)

Or as a maven dependency:

<dependency>
     <groupId>org.reactome.server.tools</groupId>
     <artifactId>reaction-exporter</artifactId>
     <version>1.1.2</version>
</dependency>

<repository>
    <id>pst-release</id>
    <name>EBI Nexus Repository</name>
    <url>https://www.ebi.ac.uk/Tools/maven/repos/content/repositories/pst-release</url>
</repository>

Recommend Projects