Skip to content

FalkoHof/PEANuT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PEANuT - A plugin for pathway enrichment analysis

PEANuT is a Cytoscape 2.8.3 plugin for pathway enrichment analysis.

summary

PEANuT utilizes data from the following databases:

The version for Cytoscape 3.x is available via https://sourceforge.net/projects/peanutv3/

PEANuT is designed to work in concert with the VIPER and COMFI plugins.

If you use PEANuT please cite:

Garmhausen, M. et al. Virtual pathway explorer (viPEr) and pathway enrichment analysis tool (PEANuT): creating and analyzing focus networks to identify cross-talk between molecules and pathways. BMC Genomics 16, 790 (2015).

Installation

System requirements

Installation procedure

In general the installation procedure comprises 2 simple, quick steps:

  1. Download and install PEANuT in Cytoscape
  2. Set up PEANuT through the “Download/update dependencies” submenu

Installation in Cytoscape

There are three easy, different ways to install PEANuT in Cytoscape:

  1. Search for the PEANuT plugin under the Cytoscape menu “plugins” “manage plugins” and click on install.
  2. Download the PEANuT.jar file from the project page and click on “Plugins” “Install plugin from file” and select the downloaded .jar file.
  3. Download the PEANuT.jar file from the project page and place it in the “plugins” folder in your Cytoscape installation directory.

menuOverview If the plugin is correctly installed you should now be able to see a new “PEANuT” entry in the “plugins menu”. If that is not the case try restarting Cytoscape.

Setting up PEANuT

In order to work properly PEANuT requires several files from the ConsensusPathDB and WikiPathways databases. To download these files go to the “Download/update dependencies” submenu in the “PEANuT” entry. You should see a dialogue like below pop up. Just click on the symbol in the red circle and download all files. This should only take a few seconds. When the download is completed you will be notified of a successful download and the status icon will switch from the red cross to a green tick. This means that PEANuT is now ready to use! installation2

If you have no access to the internet or can't download the files due to server issues from the databases you can also download a zipped archive here. After downloading simply unzip the contents into you Cytoscape plugin folder. However the zip file might contain slightly older file versions.

Compile the project from sources

  1. clone the git repository to your computer
  2. open the build.properties
  3. set the following two variables: ..* classpath.local.location=TheFolderThatContainsThisSourceCode/lib ..* cytoscape.plugins.path=YourCytoscapeFolder/plugins/
  4. make sure you have ant installed
  5. run ant build.xml to compile the plugin

User guide

The Menu structure

The PEANuT menu comprises the submenus:

  1. Find pathways
  2. Show results
  3. Download/update dependencies download_menu

Find pathways

The menu entry “Find pathways” allows the user to annotate the nodes of a Cytoscape session with information from the three different pathway databases ConsensusPathDB, Pathway Commons and WikiPathways.

After clicking on the “Find pathways” submenu a dialogue as displayed in the figure below will pop up. There you have the possibility so select the database of your choice via the 3 tabs displayed on top of the dialogue. After selecting a database you will be provided with several other options that need to be set according to your data and preferences.findPathwaysMenu

Show results

The menu entry “Show results” allows the user to browse the results of the pathway annotation procedure. When clicking on the “Show results” submenu a dialogue as displayed in the figure below will pop up. There you have the possibility so select to e.g. select a background and focus network, a cutoff p-Value for enrichment testing or to export the results as a tab separated file.

  1. Select the background network: Select the network which will be the background for the statistical testing, e.g. Yeast or Human interactome. The default is the largest network present in your session.
  2. Select the focus network: Select the network for which you want to know if there are any pathways enriched.
  3. Set p-Value cutoff: You can enter p-Value cutoff. Only pathways with a smaller p-Value than the cutoff value will be displayed. The default is 0.001. Allowed values range from 1 - 0.
  4. (Re)calculate results: When clicking the calculate results button the application will calculate which pathways are enriched (based on options 1-3).
  5. Click on the columns to sort the results: You can click on the header of each column to sort it either alphabetically or according to its numeric value. The columns display the names of the pathway, the number of nodes in the fous network associated with this pathway, the coverage of the pathway (as fraction and percent), the respective p-Value, the datasource of the pathway and an option whether you later want to select the nodes in the focus network or not (see also point 8). Note that the number of nodes and the coverage may differ. This is due to the fact that some networks may contain additional nodes for super pathways, parts of super pathways, catalytic reactions or nodes for different isoforms that are mapped to the same Entrez gene IDs.
  6. Search result table for keywords: If you are looking for specific pathways you can type keywords in this text field and search the result table (case insensitive).
  7. Export results as .tab file: Clicking this button will open a file chooser that will allow you to save the results displayed in the table as a tab separated file that can easily be imported in to Excel, OpenOffice etc.
  8. Select nodes in the focus network: Clicking this button will select the nodes of the ticked pathways (Column select nodes) in the focus network. resultMenu

If you want to get some hand on experience with PEANuT you can download a test network comprised out of the yeast proteome here and have a look at our walkthrough example below.

Walkthrough example

Prerequisites

Before we can dive into the example you need to:

  1. Install Cytoscape and PEANuT (see our installation guide)
  2. Download our example network

Getting started

After you have started Cytoscape open the example session file via "File" --> "Open" and the select the yestTestNetwork.cys you have just downloaded.

Using the plugin

Using the plugin consist of two simple steps:

  1. Annotate the networks with pathway data
  2. Calculate and review the results

If you want a detailed overview on how to use the different submenus see here.

Annotating the network with pathway data

To annotate the network with pathway data go to the menu "Plugins"-->"PEANuT"-->"Find pathways". This only needs to be done once for each session file. For this example e.g. select ConsensusPathDB.

  1. Set the organism to Yeast
  2. unselect import KEGG interactions
  3. select "entrezgene" in the combo box
  4. Click start

Calculate and review the results

To review the results of possible significant enriched pathways go to the menu "Plugins"-->"PEANuT"-->"Show pathway statistics".

  1. Select "Binary-GS.txt" as background network
  2. Select "Binary-GS.txt--child" as focus network
  3. Change the p-Value to you are prefrences or leave it at 0.001
  4. Click (re)calculate
  5. If you chose p=0.001 you will see a table comprising of only one entry.
Pathway # Nodes (focus) Coverage Coverage (%) p-Value Datasource
Trehalose Biosynthesis 4 4/4 100.00 2.066E-4 CPDB (Wikipathways)

You can click on "Save all", save the result as a tab separated file and import it into Excel. This is done in Excel via "File"--> "open", setting the file filter to "enable all documents" and then simply selecting and opening it. Afterwards Excel will ask you in a series of dialogues which kind of delimiter this file uses. Just select tab and "Finish".

If you want to play a bit around with the test network, just create other smaller or larger subnetworks and test for enrichment or annotate the networks with pathway data from other databases (e.g. Pathway Commons or WikiPathways).

Troubleshooting

You can also ask questions in our google group.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages