Help:Viewing Pathways
From WikiPathways
(fixing link to www.pathvisio.org) |
(updated for pvjs v1.0.0) |
||
Line 1: | Line 1: | ||
- | + | __NOTOC__ | |
- | + | Each pathway at WikiPathways is displayed on its own '''Pathway Page'''. In addition to the graphical representation of the pathway, they pathway page also includes other information about the pathway. | |
- | + | == Graphical representation == | |
- | + | === Interactive pathway viewer === | |
- | The graphical representation of the pathway is located at the top of the ''Pathway Page'', as an interactive viewer: | + | The graphical representation of the pathway is located at the top of the '''Pathway Page''', as an interactive viewer: |
- | * You can drag the pathway to pan | + | * You can drag the pathway to pan and scroll to zoom. To reset pan or zoom, click the '''Reset''' button in the lower right corner. |
- | * | + | * Search for a pathway element using the search box in the upper right corner. Potential search hits are displayed as a list while typing, selecting one of them clicking enter will focus the view on the relevant element and highlight it. |
- | * | + | * Click on any pathway element to display its annotations in a pop-up annotations panel. |
- | * The | + | * The annotations panel is organized as a list of systems and contains link-outs to all cross-references for the xref. |
- | * To find other pathways with the selected element, click the | + | * To find other pathways with the selected element, click the magnifier icon next to the data node title in the annotations panel. This initializes a search at WikiPathways for the particular element. |
- | * | + | * Move the annotations panel by click-and-drag on the '''move''' icon in the upper left corner, and use the '''close''' icon in the upper right corner to close the panel. |
- | + | ||
- | + | === Data formats === | |
- | + | The pathway data can be downloaded in several formats using the '''Download''' button under the pathway image: | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | The pathway data can be downloaded in several formats using the Download button under the pathway image: | + | |
* PNG and PDF image formats | * PNG and PDF image formats | ||
* Gene list (.txt) format | * Gene list (.txt) format | ||
- | * GPML format (GenMAPP Pathway Markup Language), an XML for annotated, curated pathway content | + | * GPML format (GenMAPP Pathway Markup Language), an XML for annotated, curated pathway content. GPML-formatted files can be used in [http://www.pathvisio.org PathVisio] and [http://www.cytoscape.org Cytoscape]. |
- | + | * PWF format, for use in the [http://www.ducciocavalieri.org/dct.htm| Eu.Gene ] application. | |
- | * PWF format, for use in the [http://www.ducciocavalieri.org/dct.htm| Eu.Gene ] | + | |
Batch download of pathways in gpml, pdf, pwf, svg, png and txt formats is available here: [[Download_Pathways |Batch Download]]. A flat file of all pathways is also available on the batch download page in both html and txt format. | Batch download of pathways in gpml, pdf, pwf, svg, png and txt formats is available here: [[Download_Pathways |Batch Download]]. A flat file of all pathways is also available on the batch download page in both html and txt format. | ||
- | <br> | + | <br>To edit the pathway, click the '''Edit pathway''' link under the pathway image to start [[:Help:Editing Pathways|editing]] the pathway. |
- | + | == Curation Tags == | |
- | Curation | + | '''Curation Tags''' are a set of tags that can be added to a pathway to notify the author and community about the state of the pathway. For example, you could tag a pathway that isn't annotated properly or tag your own pathway as work in progress. For more information on Curation tags and how to add them, please see the [[:Help:CurationTags|Curation Tags]] page. |
- | + | == Description == | |
- | The ''Description'' section contains a description the pathway, entered by the author. The | + | The '''Description''' section contains a description the pathway, entered by the author. The description can be edited by clicking the '''Edit''' link on the right side of the '''Description''' section. |
- | + | == Ontology Tags == | |
- | The ''Ontology Tags'' section contains any ontology tags added to the pathway, and an interface for adding ontology tags. Ontology tags can be located through a search interface and browsable trees for the supported ontologies. | + | The '''Ontology Tags''' section contains any ontology tags added to the pathway, and an interface for adding ontology tags. Ontology tags can be located through a search interface and browsable trees for the supported ontologies. |
- | + | == Bibliography == | |
- | The ''Bibliography'' section contains relevant references for the pathway, from literature, textbooks, the web and other sources. The | + | The '''Bibliography''' section contains relevant references for the pathway, from literature, textbooks, the web and other sources. The bibliography can be edited in the pathway editor. Click on the '''Edit pathway''' button below the pathway image to start the editor. Right-click anywhere on the pathway drawing board and choose '''Literature -> Add literature reference'''. |
- | == | + | == History == |
- | + | The '''History''' section provides detailed information about the changes made to the pathway. The pathway history is formatted as a table, with information on when the change was made, who made the change, and any comments entered by the user. A direct link to the pathway change is available by clicking the '''view''' link for each change. A '''revert''' link is also available for reverting the pathway to a previous version.<br> | |
+ | Any two versions of a pathway can be compared visually in the '''Pathway Difference Viewer'''. To do this, select two versions of the pathway in the history table by clicking the radio buttons in the '''Compare''' column, then click the '''Compare selected versions''' button. In the difference viewer, both versions of the pathway will open with the differing parts highlighted in yellow. Clicking on any highlighted part will bring up details of the difference between the two versions. | ||
- | == | + | == External references == |
- | The '' | + | The '''External references''' section contain a list of annotated genes, proteins, metabolite and pathway nodes that are on the pathway. You can click the info icon (see screenshot below) to show a dialog containing links to many different resources that provide detailed information. |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
{{Help:XrefPanel}} | {{Help:XrefPanel}} | ||
+ | |||
+ | == Highlighting data nodes on pathways == | ||
+ | |||
+ | You can specify elements that you want to highlight on a pathway using a url with the following syntax: | ||
+ | [http://www.google.com/url?sa=D&q=http://test.wikipathways.org/index.php%3Ftitle%3DPathway:WP4%26label%3DCRH%26xref%3D8525,Entrez%2520Gene&usg=AFQjCNEH0y66C17ypUnEoftni-SpTWoPWA http://www.google.com/url?sa=D&q=http://test.wikipathways.org/index.php%3Ftitle%3DPathway:WP4%26label%3DCRH%26xref%3D8525,Entrez%2520Gene&usg=AFQjCNEH0y66C17ypUnEoftni-SpTWoPWA] | ||
+ | |||
+ | * Highlights are organized into a box on the left with an entry for each highlight. Clicking one of the highlights focuses the viewer on the corresponding element on the pathway. | ||
+ | * The url parameters for highlighting can be "label" (to match by text label) or "xref" (to match by xref, format: id,datasource). | ||
+ | * You can specify multiple parameters to highlight multiple items. You can also specify an array of highlight colors using the color parameter: | ||
+ | [http://www.google.com/url?sa=D&q=http://wikipathways.org/index.php%3Ftitle%3DPathway:WP4%26label%3DCRH%26xref%3D8525,Entrez%2520Gene%26label%3Dinvalid%26label%3DDAG%26colors%3Dred,orange,greenusg=AFQjCNEGjvUaWX_Xd2EfGJzM_X5xG6Prng http://www.google.com/url?sa=D&q=http://wikipathways.org/index.php%3Ftitle%3DPathway:WP4%26label%3DCRH%26xref%3D8525,Entrez%2520Gene%26label%3Dinvalid%26label%3DDAG%26colors%3Dred,orange,greenusg=AFQjCNEGjvUaWX_Xd2EfGJzM_X5xG6Prng] | ||
+ | |||
+ | * Labels or xrefs that can't be located on the pathway are shown in gray ("label=invalid" in the example above). Id mapping is not performed for xrefs, only exact matches are highlighted. | ||
<p>[[:Help:Contents|Return to Help Contents]]</p> | <p>[[:Help:Contents|Return to Help Contents]]</p> | ||
<p>[[:Help:Editing Pathways|Continue to Editing Pathways]]</p> | <p>[[:Help:Editing Pathways|Continue to Editing Pathways]]</p> |
Revision as of 01:14, 1 February 2014
Each pathway at WikiPathways is displayed on its own Pathway Page. In addition to the graphical representation of the pathway, they pathway page also includes other information about the pathway.
Graphical representation
Interactive pathway viewer
The graphical representation of the pathway is located at the top of the Pathway Page, as an interactive viewer:
- You can drag the pathway to pan and scroll to zoom. To reset pan or zoom, click the Reset button in the lower right corner.
- Search for a pathway element using the search box in the upper right corner. Potential search hits are displayed as a list while typing, selecting one of them clicking enter will focus the view on the relevant element and highlight it.
- Click on any pathway element to display its annotations in a pop-up annotations panel.
- The annotations panel is organized as a list of systems and contains link-outs to all cross-references for the xref.
- To find other pathways with the selected element, click the magnifier icon next to the data node title in the annotations panel. This initializes a search at WikiPathways for the particular element.
- Move the annotations panel by click-and-drag on the move icon in the upper left corner, and use the close icon in the upper right corner to close the panel.
Data formats
The pathway data can be downloaded in several formats using the Download button under the pathway image:
- PNG and PDF image formats
- Gene list (.txt) format
- GPML format (GenMAPP Pathway Markup Language), an XML for annotated, curated pathway content. GPML-formatted files can be used in PathVisio and Cytoscape.
- PWF format, for use in the Eu.Gene application.
Batch download of pathways in gpml, pdf, pwf, svg, png and txt formats is available here: Batch Download. A flat file of all pathways is also available on the batch download page in both html and txt format.
To edit the pathway, click the Edit pathway link under the pathway image to start editing the pathway.
Curation Tags
Curation Tags are a set of tags that can be added to a pathway to notify the author and community about the state of the pathway. For example, you could tag a pathway that isn't annotated properly or tag your own pathway as work in progress. For more information on Curation tags and how to add them, please see the Curation Tags page.
Description
The Description section contains a description the pathway, entered by the author. The description can be edited by clicking the Edit link on the right side of the Description section.
Ontology Tags
The Ontology Tags section contains any ontology tags added to the pathway, and an interface for adding ontology tags. Ontology tags can be located through a search interface and browsable trees for the supported ontologies.
Bibliography
The Bibliography section contains relevant references for the pathway, from literature, textbooks, the web and other sources. The bibliography can be edited in the pathway editor. Click on the Edit pathway button below the pathway image to start the editor. Right-click anywhere on the pathway drawing board and choose Literature -> Add literature reference.
History
The History section provides detailed information about the changes made to the pathway. The pathway history is formatted as a table, with information on when the change was made, who made the change, and any comments entered by the user. A direct link to the pathway change is available by clicking the view link for each change. A revert link is also available for reverting the pathway to a previous version.
Any two versions of a pathway can be compared visually in the Pathway Difference Viewer. To do this, select two versions of the pathway in the history table by clicking the radio buttons in the Compare column, then click the Compare selected versions button. In the difference viewer, both versions of the pathway will open with the differing parts highlighted in yellow. Clicking on any highlighted part will bring up details of the difference between the two versions.
External references
The External references section contain a list of annotated genes, proteins, metabolite and pathway nodes that are on the pathway. You can click the info icon (see screenshot below) to show a dialog containing links to many different resources that provide detailed information.
Highlighting data nodes on pathways
You can specify elements that you want to highlight on a pathway using a url with the following syntax: http://www.google.com/url?sa=D&q=http://test.wikipathways.org/index.php%3Ftitle%3DPathway:WP4%26label%3DCRH%26xref%3D8525,Entrez%2520Gene&usg=AFQjCNEH0y66C17ypUnEoftni-SpTWoPWA
- Highlights are organized into a box on the left with an entry for each highlight. Clicking one of the highlights focuses the viewer on the corresponding element on the pathway.
- The url parameters for highlighting can be "label" (to match by text label) or "xref" (to match by xref, format: id,datasource).
- You can specify multiple parameters to highlight multiple items. You can also specify an array of highlight colors using the color parameter:
- Labels or xrefs that can't be located on the pathway are shown in gray ("label=invalid" in the example above). Id mapping is not performed for xrefs, only exact matches are highlighted.