Cytoscape Wiki|
← Revision 4 as of 2007-01-16 02:53:29
Size: 2996
Comment:
|
← Revision 5 as of 2007-06-28 18:41:34 →
Size: 2959
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| LinkOut provides a mechanism to link nodes and edges to external web resources within Cytoscape. Right-clicking on a node or edge in Cytoscape view opens a popup menu with a list of web links. | !LinkOut provides a mechanism to link nodes and edges to external web resources within Cytoscape. Right-clicking on a node or edge in Cytoscape view opens a popup menu with a list of web links. |
| Line 3: | Line 3: |
| The external links are specified in a {{{linkout.props}}} file which is included in the cytoscape.jar file. The defaults include a number of links such as Entrez, SGD, iHOP, Google, as well as a number of species-specific links. In addition to the default links, users can customize the LinkOut menu by adding (or removing) links by editing the linkout properties that can be found in the __Edit → Preferences → Properties...__ dialog. | The external links are specified in a {{{linkout.props}}} file which is included in the cytoscape.jar file. The defaults include a number of links such as Entrez, SGD, iHOP, and Google, as well as a number of species-specific links. In addition to the default links, users can customize the !LinkOut menu by adding (or removing) links by editing the linkout properties (found under Edit → Preferences → Properties...). |
| Line 15: | Line 15: |
| The '''{{{%ID%}}}''' string in the URL is a place-holder for the node label. When the popup menu is generated this marker is substituted with the node label. In the above example the generated SGD link for YIM protein is: {{{http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=YIM1}}}. If you want to query based on a different attribute you currently need to specify a different Node Label using the VizMapper. | The '''{{{%ID%}}}''' string in the URL is a place-holder for the node label. When the popup menu is generated this marker is substituted with the node label. In the above example, the generated SGD link for the YIM1 protein is: {{{http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=YIM1}}}. If you want to query based on a different attribute you currently need to specify a different Node Label using the !VizMapper. |
| Line 17: | Line 17: |
| Currently there is no mechanism to check whether the constructed URL query is correct and if the node label is meaningful. Similarly there is no ID mapping between various identifiers. For example, a link to NCBI Entrez from a network that uses ensembl gene identifiers as node label will produce a link to Entrez using ensembl ID, which results in an incorrect link. It is the users responsibility to ensure that the node label that is used as the search term in the URL link will result in a meaningful link. | Currently there is no mechanism to check whether the constructed URL query is correct and if the node label is meaningful. Similarly, there is no ID mapping between various identifiers. For example, a link to NCBI Entrez from a network that uses ensembl gene identifiers as node labels will produce a link to Entrez using ensembl ID, which results in an incorrect link. It is the user's responsibility to ensure that the node label that is used as the search term in the URL link will result in a meaningful link. |
| Line 19: | Line 19: |
| '''Adding or Removing links''' The default links are defined in a {{{linkout.props}}} file contained in the linkout.jar. These links are normal java properties and can be editited while running in the __Edit → Preferences → Properties...__ dialog. New links can be defined this way as well. New links can be defined at startup in a separate file and loaded from the command line, either by specifying a file containing the links {{{cytoscape.sh -P new_linout.props}}} or as individual properties {{{cytoscape.sh -P linkouturl.yeast.SGD=http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=%ID%}}}. Any links defined on the command line will supersede the default links. |
=== Adding or Removing Links === The default links are defined in a {{{linkout.props}}} file contained in {{{linkout.jar}}}. These links are normal java properties and can be edited by going to Edit → Preferences → Properties... . New links can be defined this way as well. New links can be defined at startup in a separate file and loaded from the command line, either by specifying a file containing the links {{{cytoscape.sh -P new_linout.props}}} or as individual properties {{{cytoscape.sh -P linkouturl.yeast.SGD=http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=%ID%}}}. Any links defined on the command line will supersede the default links. |
| Line 21: | Line 22: |
| To remove a link from the menu simply delete the property from the __Edit → Preferences → Properties...__ dialog. | To remove a link from the menu simply delete the property, using Edit → Preferences → Properties... . |
LinkOut provides a mechanism to link nodes and edges to external web resources within Cytoscape. Right-clicking on a node or edge in Cytoscape view opens a popup menu with a list of web links.
The external links are specified in a linkout.props file which is included in the cytoscape.jar file. The defaults include a number of links such as Entrez, SGD, iHOP, and Google, as well as a number of species-specific links. In addition to the default links, users can customize the LinkOut menu by adding (or removing) links by editing the linkout properties (found under Edit → Preferences → Properties...).
External links are listed as ‘key’-‘value’ pairs in the linkout.props file where key specifies the name of the link and value is the search URL. The LinkOut menus are organized in a hierarchical structure that is specified in the key. All key terms start with the keyword linkouturl.
For example, the following entry: linkouturl.yeast.SGD=http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=%ID%
places the SGD link under the yeast submenu. This link will appear in Cytoscape as:
attachment:Figure1_linkout.png
In a similar fashion one can added new submenus.
The %ID% string in the URL is a place-holder for the node label. When the popup menu is generated this marker is substituted with the node label. In the above example, the generated SGD link for the YIM1 protein is: http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=YIM1. If you want to query based on a different attribute you currently need to specify a different Node Label using the VizMapper.
Currently there is no mechanism to check whether the constructed URL query is correct and if the node label is meaningful. Similarly, there is no ID mapping between various identifiers. For example, a link to NCBI Entrez from a network that uses ensembl gene identifiers as node labels will produce a link to Entrez using ensembl ID, which results in an incorrect link. It is the user's responsibility to ensure that the node label that is used as the search term in the URL link will result in a meaningful link.
Adding or Removing Links
The default links are defined in a linkout.props file contained in linkout.jar. These links are normal java properties and can be edited by going to Edit → Preferences → Properties... . New links can be defined this way as well. New links can be defined at startup in a separate file and loaded from the command line, either by specifying a file containing the links cytoscape.sh -P new_linout.props or as individual properties cytoscape.sh -P linkouturl.yeast.SGD=http://db.yeastgenome.org/cgi-bin/locus.pl?locus\=%ID%. Any links defined on the command line will supersede the default links.
To remove a link from the menu simply delete the property, using Edit → Preferences → Properties... .