Skip to content

CGU-CERTH/BioPAX.Viz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BioPAX.Viz

BioPAXViz is a Cytoscape (version 3.x) app providing a comprehensive framework for metabolic pathway visualization.

Install notes

Requirements

* Cytoscape: (verified to work in v3.4.0) * Java (TM) SE Development Kit (required only for building the project from source): verified to work with v.1.8.0_45_ Compatible with all major Operating Systems: verified to work with Linux Ubuntu 14.04 LTS and Windows 10_

Installing the App

1. Download the pre-compiled jar file from the target directory 2. Open Cytoscape. 3. From the menu list select: Apps -> App Manager 4. Click on the 'Install from file' button 5. Search for the BioPaxViz.jar file you downloaded in Step 1 and add it. 6. The App should be now visible and available though the menu list: Apps -> BioPaxViz (1.0) 7. Done!

Running the App on the sample input

1. Download the sample directory (it should contain 39 BioPAX files and a tree file). The BioPAX files already contain information about the presence/absence of the pathway and of the proteins within the pathway. 2. Open Cytoscape. 3. From the menu list select: Apps -> BioPaxViz (1.0) 4. From the pop-up window that will come up select the directory you downloaded in Step 1. 5. Hit the 'Display pathway' button!

Workflow for preparing your own input

1. Download the pathway files in BioPAX format (BioCyc, MetaCyc, etc). 2. Run the BioPAXClient software in order to introduce the presence/absence information for each of the BioPAX files; however, the means to obtain the information is independent to the plugin (user decision). 3. Generate the tree file. The tree file format is historical/legacy, and can be easily be converted from a [Newick](https://en.wikipedia.org/wiki/Newick_format) tree format input file; the first column is node name, the second is parent name, and leaf nodes of the tree are marked with the third column with ‘undef’ value in it. The root node does not have a parent and there should obviously be only one root. As an example, see the tree structure below:
node80
node63		node80
FNUC-ATC	node63	undef
XFAS-9A5	node63	undef
MPUL-UAB	node80	undef

(optional) Building the project and creating a JAR file

This is only recommended for expert users that have some programming experience. Otherwise you should directly use the provided pre-compiled jar file, located in the target directory.

The easiest way to build the application and create the jar file, is through the use of an IDE such as NetBeans or Eclipse. You can also build the project through a command line interface with the following commands (slight changes may exist depending on OS):

  • Build the project from within the source:
    javac -cp ".:/path/2/library/jar/files" *.java
  • Create the .jar file:
    jar cfm BioPaxViz.jar app-manifest *.class


Uninstalling the App

1. Open Cytoscape. 2. From the menu list select: Apps -> App Manager 3. Click on the 'Currently Installed' tab 4. Select the 'BioPaxViz' app and click unistall 5. The App will be removed from Cytoscape after the next restart

Usage notes

* You can select any node from the tree structure and see the instance of the reference pathway for the selected node/organism. * The tree structure is shown in the smaller window at the top left corner of the main window by default and it is resizable and movable at any location in the Cytoscape window. If you dismiss this window in the background you can always bring it back to the front by hitting the 'Space' button in the keyboard. * The presence property is denoted by the orange color while the absence property is denoted by the purple color! * In case you need to display a single BioPAX file, when the pop-up window is displayed at first you have to enable the 'Select file' radio-button option and then choose a specific BioPAX file (.owl extension) from the File-chooser window.

Copyright (c) 2016 CERTH
Author: Fotis E. Psomopoulos
Last edit: 3 December 2016

About

BioPAXViz is a Cytoscape (version 3.x) app providing a comprehensive framework for metabolic pathway visualization

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published