Difference between revisions of "README Cytoscape plugin 3.0 Beta"

From irefindex
(Used Wiki syntax to improve the readability. Included additional notes.)
Line 1: Line 1:
 
Date : Nov 21st, 2008
 
Date : Nov 21st, 2008
<pre>
 
The iRefIndex plugin for Cytoscape has not been officially released.  If you are looking at this page,
 
you have probably been directed here from the Cytoscape plugin directory at
 
ftp://ftp.no.embnet.org/irefindex/Cytoscape/plugin . 
 
This plugin is for testing purposes only.  Join the Google groups email list at
 
http://groups.google.com/group/irefindex?hl=en
 
to be informed of the official release and updates.
 
</pre>
 
  
 +
The iRefIndex plugin for Cytoscape has not been officially released.  If you are looking at this page, you have probably been directed here from the Cytoscape plugin directory at ftp://ftp.no.embnet.org/irefindex/Cytoscape/plugin . This plugin is for testing purposes only. Join the Google groups email list at http://groups.google.com/group/irefindex?hl=en to be informed of the official release and updates.
  
1. Before starting :
+
==Installation==
Make sure that Cytoscape is not running. <br>
 
Remove any other installations of iRefIndex_beta# or directories created by iRefIndex. <br>
 
Make sure Cytoscape has at leas 128Mb memory (http://cytoscape.org/cgi-bin/moin.cgi/How%20to%20increase%20memory%20for%20Cytoscape)<br>
 
  
2. Copy both the IRefIndex_beta3.jar and iRefDATA_MMDDYYYY.irfz files to the plugin directory of Cytoscape.
+
# Obtain Cytoscape from http://cytoscape.org/ and follow the installation instructions for that software.
 +
# Before starting:
 +
#* Make sure that Cytoscape is not running.
 +
#* Remove any other installations of iRefIndex_beta# or directories created by iRefIndex.
 +
#* Make sure Cytoscape has at least 128MB memory (http://cytoscape.org/cgi-bin/moin.cgi/How%20to%20increase%20memory%20for%20Cytoscape)
 +
# Copy both the IRefIndex_beta3.jar and iRefDATA_MMDDYYYY.irfz files to the plugin directory of Cytoscape. For example:
 +
#* On Unix: <tt>/...../Cytoscape_v2.6.0/plugins/</tt>
 +
#* On Windows: <tt>\.....\Cytoscape_v2.6.0\plugins\</tt>
 +
#* (You should have write privileges for this directory.)
 +
# Start Cytoscape and select IRefIndex_beta3 from plugin menu.
 +
# First time installation may take up to 5 minutes (while the plugin creates Java index objects).
 +
# If the installation is successful, you will see a list of indices in the Results text box in green and if the installation fails you will see errors in red text. (If you cannot see the iRefIndex panel please click on the title iRefIndex, near the Network tab.)
  
 +
==Q&A==
  
e.g :
+
# How do I search all the interactions involving the protein NP:477306?
Unix
+
#* Type <tt>NP_477306</tt> on the search text box.
/...../Cytoscape_v2.6.0/plugins/
+
#* Select <tt>ACCESSION</tt> from type drop down menu.
 
+
#* (Optional) Restrict the search within a certain taxon identifier by selecting the id from Taxon.
Windows:
+
#* Click Search & load.
\.....\Cytoscape_v2.6.0\plugins\
+
# How do I load a list of identifiers from a file?
 
+
#* For this you need to create plain text file with the list of identifiers.
**you should have write privileges for this directory
+
#* First line of the file should be the type of search and the taxonomy identifier. For example:<br><tt>#accession:96065</tt>
 
+
#* There is a sample file available in the following directory:
3. Start Cytoscape and select  IRefIndex_beta3 from plugin menu.
+
#** On Unix: <tt>/...../Cytoscape_v2.6.0/plugins/iRefIndex/Sample_batch.txt</tt>
 
+
#** On Windows: <tt>\.....\Cytoscape_v2.6.0\plugins\iRefIndex\Sample_batch.txt</tt>
4. First time installation may take up to 5 minutes (while the plugin creates Java index objects).
 
 
 
5. If the installation is successful, you will see a list of indices in the Results text box in green
 
and if the installation fails you will see errors in red text. (If you can not see the iRefIndex panel
 
please click on the title iRefIndex, near the Network tab)
 
 
 
 
 
-----------------------------------------
 
 
 
Q&A
 
 
 
1. How do I search all the interactions involving the protein NP:477306
 
  - Type NP_477306 on the search text box
 
  - Select ACCESSION from type drop down menu
 
  - (optional) restrict the search within a certain taxon identifier by selecting the id from Taxon
 
  - Click Search & load
 
 
 
2. How do I load a list of identifiers form a file
 
  - For this you need to create plain text file with the list of identifiers
 
  - First line of the file should be the type of search and the taxonomy identifier
 
    e.g. #accession:96065
 
  - There is a sample file available in the following directory
 
    Unix
 
    /...../Cytoscape_v2.6.0/plugins/iRefIndex/Sample_batch.txt  
 
    Windows:
 
    \.....\Cytoscape_v2.6.0\plugins\iRefIndex\Sample_batch.txt
 

Revision as of 17:21, 26 January 2009

Date : Nov 21st, 2008

The iRefIndex plugin for Cytoscape has not been officially released. If you are looking at this page, you have probably been directed here from the Cytoscape plugin directory at ftp://ftp.no.embnet.org/irefindex/Cytoscape/plugin . This plugin is for testing purposes only. Join the Google groups email list at http://groups.google.com/group/irefindex?hl=en to be informed of the official release and updates.

Installation

  1. Obtain Cytoscape from http://cytoscape.org/ and follow the installation instructions for that software.
  2. Before starting:
  3. Copy both the IRefIndex_beta3.jar and iRefDATA_MMDDYYYY.irfz files to the plugin directory of Cytoscape. For example:
    • On Unix: /...../Cytoscape_v2.6.0/plugins/
    • On Windows: \.....\Cytoscape_v2.6.0\plugins\
    • (You should have write privileges for this directory.)
  4. Start Cytoscape and select IRefIndex_beta3 from plugin menu.
  5. First time installation may take up to 5 minutes (while the plugin creates Java index objects).
  6. If the installation is successful, you will see a list of indices in the Results text box in green and if the installation fails you will see errors in red text. (If you cannot see the iRefIndex panel please click on the title iRefIndex, near the Network tab.)

Q&A

  1. How do I search all the interactions involving the protein NP:477306?
    • Type NP_477306 on the search text box.
    • Select ACCESSION from type drop down menu.
    • (Optional) Restrict the search within a certain taxon identifier by selecting the id from Taxon.
    • Click Search & load.
  2. How do I load a list of identifiers from a file?
    • For this you need to create plain text file with the list of identifiers.
    • First line of the file should be the type of search and the taxonomy identifier. For example:
      #accession:96065
    • There is a sample file available in the following directory:
      • On Unix: /...../Cytoscape_v2.6.0/plugins/iRefIndex/Sample_batch.txt
      • On Windows: \.....\Cytoscape_v2.6.0\plugins\iRefIndex\Sample_batch.txt