Help:Guidelines EditorPalette

From WikiPathways

(Difference between revisions)
Jump to: navigation, search
Current revision (19:12, 30 August 2021) (view source)
m (Protected "Help:Guidelines EditorPalette" [edit=sysop:move=sysop])
 
(91 intermediate revisions not shown.)
Line 1: Line 1:
-
This guide describes the recommended uses of the most commonly used elements of the WikiPathways editor palette. Examples are taken directly from the WikiPathways archives. If you have questions about specific cases, contact the [https://groups.google.com/forum/#!forum/wikipathways-discuss|WikiPathways discussion mailing list].
+
This guide describes the recommended utilization of the most commonly used elements of the WikiPathways editor palette. Examples are taken directly from the WikiPathways archives. If you have questions about specific cases, contact the [https://groups.google.com/forum/#!forum/wikipathways-discuss|WikiPathways discussion mailing list].  
-
= Interactions =
+
 
 +
For each figure, the original pathway is linked to from the image header.
 +
 
 +
= MIM Interactions - Molecular Interaction Maps =
 +
The WikiPathways editor includes a set of MIM interaction types, based on the [http://discover.nci.nih.gov/mim/ Molecular Interaction Maps] notation. Refer to the [http://discover.nci.nih.gov/mim/formal_mim_spec.pdf formal MIM specification] for details on recommended usage.
-
==== Line / Arrow ====
 
-
The solid line and arrow are used to denote a variety of processes, including <b>conversion</b>, <b>translocation</b>, <b>activation</b>, <b>binding</b> and <b>modification</b>.
 
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Enzymatic conversion
+
  ![[Pathway:WP2272|Necessary stimulation]]
-
  !Receptor binding
+
  ![[Pathway:WP58|Binding]]
-
  !Translocation between compartments
+
  ![[Pathway:WP550|Conversion and Catalysis]]
-
  !Activation by cAMP
+
  ![[Pathway:WP554|Inhibition]]
  |-
  |-
-
  |[[Image:Arrow.png]]
+
  |[[Image:MIM-Necessary-Stimulation.png|border]]
-
  |[[Image:Arrow_binding.png]]
+
  |[[Image:MIM-Binding.png|250px|border]]
-
  |[[Image:Arrow_translocation.png]]
+
  |[[Image:Arrow.png|border]]
-
  |[[Image:Arrow_activation.png]]
+
  |[[Image:mim-inhibition.png|border|300px]]
|}
|}
-
 
-
==== Dashed line / dashed arrow ====
 
-
The dashed line and arrow are used to denote an uncertain process or a process that involves additional steps not outlined in the current diagram.
 
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Multi-step process without details
+
  ![[Pathway:WP1601|Stimulation]]
 +
![[Pathway:WP554|Transcription-Translation]]
  |-
  |-
-
  |[[Image:Dashed_MultiStep.png|250px]]
+
  |[[Image:MIM-Stimulation2.png|border|300px]]
 +
|[[Image:Transcription.png|border|300px]]
|}
|}
-
==== T-bar ====
+
= Basic Interactions =
-
The T-bar is used to denote <b>inhibition</b>.
+
 +
==== Line / Arrow ====
 +
The solid line and arrow are used to denote a variety of processes when the more specific mim-interactions are not appropriate, including <b>translocation</b> and <b>activation</b>.
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Inhibition by transcriptional regulation
+
  ![[Pathway:WP428|Generic arrow]]
 +
![[Pathway:WP1603|Translocation between compartments]]
 +
![[Pathway:WP2059|Undefined process]]
  |-
  |-
-
  |[[Image:MIM-Inhibition2.png]]
+
  |[[Image:PlainArrow.png|border]]
 +
|[[Image:Arrow_translocation.png|border]]
 +
|[[Image:DashedArrow.png|border]]
|}
|}
-
 
==== Line types ====
==== Line types ====
-
Any interaction can have a line style of either <i>straight</i>, <i>curved</i>, <i>elbow</i> or <i>segmented</i>. The default style is straight, and is shown in the examples above. The other three line styles are used primarily to increase readability of complex pathways.
+
Any interaction can have a line style of either <i>straight</i>, <i>curved</i>, <i>elbow</i> or <i>segmented</i>. The default style is straight, and is shown in the examples above. The other three line styles are used to increase readability or to allow for a specific layout.
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Curved
+
  ![[Pathway:WP690|Curved]]
-
  !Elbow
+
  ![[Pathway:WP197|Elbow]]
-
  !Segmented
+
  ![[Pathway:WP78|Segmented]]
  |-
  |-
-
  |[[Image:Curved.png|350px]]
+
  |[[Image:Curved.png|border]]
-
  |[[Image:Elbow2.png|350px]]
+
  |[[Image:Elbow.png|border|300px]]
-
  |[[Image:Segmented.png|350px]]
+
  |[[Image:Segmented.png|border|300px]]
|}
|}
-
= Interactions - Molecular Interaction Maps (MIM) =
+
= Data nodes =
-
The WikiPathways editor includes a set of MIM interaction types, based on the [http://discover.nci.nih.gov/mim/| Molecular Interaction Maps] notation. Refer to the [http://discover.nci.nih.gov/mim/formal_mim_spec.pdf|formal MIM specification] for details on recommended usage.
+
* <b>GeneProduct</b>: The default data node, used for proteins, RNA and genes.  
 +
* <b>Metabolite</b>: Used for any metabolite, drug or small molecule.
 +
* <b>Pathway</b>: Used to denote a connection to another pathway.
 +
* <b>Protein</b>: Used specifically for proteins.
 +
* <b>RNA</b>: Used specifically for RNA, for example miRNA.
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Necessary stimulation
+
  ![[Pathway:WP1246|GeneProduct]]
-
  !Binding
+
  ![[Pathway:WP1531|Metabolite]]
-
  !Conversion
+
  ![[Pathway:WP78|Pathway]]
  |-
  |-
-
  |[[Image:MIM-Necessary-Stimulation.png]]
+
  |[[Image:GeneProduct.png|border]]
-
  |[[Image:MIM-Binding.png|250px]]
+
  |[[Image:Metabolite.png|border]]
-
  |[[Image:MIM-Conversion2.png]]
+
  |[[Image:Pathway.png|border]]
|}
|}
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Stimulation
+
  ![[Pathway:WP1544|Protein]]
-
  !Catalysis
+
  ![[Pathway:WP608|RNA]]
-
!Transcription-Translation
+
  |-
  |-
-
  |[[Image:MIM-Stimulation2.png]]
+
  |[[Image:Protein.png|border]]
-
|[[Image:MIM-Catalysis.png]]
+
  |[[Image:DataNode-RNA.png|border]]
-
|[[Image:MIM-Transcription-Translation2.png]]
+
-
|}
+
-
 
+
-
= Data nodes =
+
-
* <b>GeneProduct</b>: Default data node and used for any gene product.
+
-
* <b>Metabolite</b>: Used for any metabolite, drug or small molecule.
+
-
* <b>Pathway</b>: Used instead of a label to denote a connection to another pathway.
+
-
* <b>RNA</b>: Used for any data node that represents RNA, for example miRNA.
+
-
* <b>Protein</b>: Can be used as a more specific way of denoting protein gene products.
+
-
{|class="prettytable"
+
-
|-
+
-
!GeneProduct, Metabolite, Pathway
+
-
!RNA
+
-
!Protein
+
-
|-
+
-
|[[Image:DataNodes.png]]
+
-
  |[[Image:DataNode-RNA.png|300px]]
+
-
|[[Image:DataNode-Protein.png]]
+
|}
|}
Line 101: Line 91:
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Labels used to indicate cell type and event
+
  ![[Pathway:WP1603|Labels used to indicate event]]
-
  !Labels used to describe complexes  
+
  ![[Pathway:WP111|Labels used to describe complexes]]
  |-
  |-
-
  |[[Image:Labels1.png|300px]]
+
  |[[Image:Label-event.png|border|350px]]
-
  |[[Image:Labels2.png]]
+
  |[[Image:Label-complex.png|border]]
|}
|}
==== Line ====
==== Line ====
-
Lines can be used to denote cellular structures such as membranes.
+
Lines can be used to create more complicated graphical objects representing biological structures, or to create a pathway legend.
-
[[Image:Line1.png|border|250px]]
+
{|class="prettytable"
 +
|-
 +
![[Pathway:WP2118|Multiple lines used to represent a sarcomere]]
 +
![[Pathway:WP339|Lines used to create a legend]]
 +
|-
 +
|[[Image:Line.png|border|450px]]
 +
|[[Image:Legend.png|border]]
 +
|}
==== Arc ====
==== Arc ====
The arc is typically used to denote a cellular or molecular structure.
The arc is typically used to denote a cellular or molecular structure.
-
[[Image:Arc.png|border]]
+
 
 +
{|class="prettytable"
 +
|-
 +
![[Pathway:WP2118|Arcs used to represent a cellular structure]]
 +
![[Pathway:WP4249|Arcs used to represent an organelle]]
 +
|-
 +
|[[Image:Arc.png|border]]
 +
|[[Image:Cilium.png|border]]
 +
|}
==== Rectangle ====
==== Rectangle ====
 +
The rectangle is typically used for headers, to create an outline for a legend or as a purely graphical object:
 +
 +
{|class="prettytable"
 +
|-
 +
![[Pathway:WP509|Rectangle used as a header border]]
 +
|-
 +
|[[Image:Rectangle2.png|border]]
 +
|}
= Cellular compartments =
= Cellular compartments =
-
Cellular compartment shapes are used to specify the cellular location of processes. Using the defined cellular compartment shapes also ensures that this information is encoded in the gpml.
+
Cellular compartment shapes are used to specify the cellular location of processes. Using the defined cellular compartment shapes instead of simple graphical shapes ensures that the cellular location information is encoded in the gpml. Use the "Text Label" property of the object 9in the Properties panel) to add a title, instead of adding a separate label.
 +
{|class="prettytable"
 +
|-
 +
![[Pathway:WP1531|Cell]]
 +
![[Pathway:WP1425|Nucleus]]
 +
|-
 +
|[[Image:Cell.png|border]]
 +
|[[Image:Nucleus.png|border]]
 +
|}
 +
 
{|class="prettytable"
{|class="prettytable"
  |-
  |-
-
  !Cell
+
  ![[Pathway:WP1603|Vesicle]]
-
  !Nucleus
+
  ![[Pathway:WP2059|Mitochondria]]
-
!Vesicle
+
  |-
  |-
-
  |[[Image:Cell.png]]
+
  |[[Image:Vesicle.png|border]]
-
  |[[Image:Nucleus.png]]
+
  |[[Image:Mitochondria.png|border]]
-
|[[Image:Vesicle.png]]
+
|}
|}

Current revision

This guide describes the recommended utilization of the most commonly used elements of the WikiPathways editor palette. Examples are taken directly from the WikiPathways archives. If you have questions about specific cases, contact the discussion mailing list.

For each figure, the original pathway is linked to from the image header.

Contents

MIM Interactions - Molecular Interaction Maps

The WikiPathways editor includes a set of MIM interaction types, based on the Molecular Interaction Maps notation. Refer to the formal MIM specification for details on recommended usage.

Necessary stimulation Binding Conversion and Catalysis Inhibition
Stimulation Transcription-Translation

Basic Interactions

Line / Arrow

The solid line and arrow are used to denote a variety of processes when the more specific mim-interactions are not appropriate, including translocation and activation.

Generic arrow Translocation between compartments Undefined process

Line types

Any interaction can have a line style of either straight, curved, elbow or segmented. The default style is straight, and is shown in the examples above. The other three line styles are used to increase readability or to allow for a specific layout.

Curved Elbow Segmented

Data nodes

  • GeneProduct: The default data node, used for proteins, RNA and genes.
  • Metabolite: Used for any metabolite, drug or small molecule.
  • Pathway: Used to denote a connection to another pathway.
  • Protein: Used specifically for proteins.
  • RNA: Used specifically for RNA, for example miRNA.
GeneProduct Metabolite Pathway
Protein RNA

Graphical elements

Graphical elements are purely graphical, meaning they do not have a meaning in the network graph that defines nodes and interactions.

Label

Labels are used to describe locations, entities, processes or context:

Labels used to indicate event Labels used to describe complexes

Line

Lines can be used to create more complicated graphical objects representing biological structures, or to create a pathway legend.


Multiple lines used to represent a sarcomere Lines used to create a legend

Arc

The arc is typically used to denote a cellular or molecular structure.


Arcs used to represent a cellular structure Arcs used to represent an organelle

Rectangle

The rectangle is typically used for headers, to create an outline for a legend or as a purely graphical object:

Rectangle used as a header border

Cellular compartments

Cellular compartment shapes are used to specify the cellular location of processes. Using the defined cellular compartment shapes instead of simple graphical shapes ensures that the cellular location information is encoded in the gpml. Use the "Text Label" property of the object 9in the Properties panel) to add a title, instead of adding a separate label.

Cell Nucleus
Vesicle Mitochondria
Retrieved from "https://classic.wikipathways.org/index.php/Help:Guidelines_EditorPalette"
Personal tools