Differences between revisions 53 and 63 (spanning 10 versions)
Revision 53 as of 2007-06-29 21:42:14
Size: 26832
Editor: KeiichiroOno
Comment:
Revision 63 as of 2007-07-16 19:56:08
Size: 28661
Editor: KeiichiroOno
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
With the Cytoscape '''''Visual Style''''' feature, you can easily customize the visual appearance of your network. The following is a few examples you can do by editing '''''Visual Styles''''':
One of Cytoscape's strengths in network visualization is the ability to allow users to encode any attribute of their data (name, type, degree, weight, expression data, etc.) as a visual property (such as color, size, transparency, or font type). A set of these encoded or mapped attributes is called a Visual Style and can be created or edited using the Cytoscape !VizMapper. With the !VizMapper, the visual appearance of your network is easily customized. For example, you can:
Line 10: Line 11:
 * Encode specific physical entities into different node shapes.  * Encode specific physical entities as different node shapes.
Line 13: Line 14:
 * Set node size based on ''degree'' of the nodes. You can visually see the ''hub'' of a network.  * Set node sizes based on the degree of connectivity of the nodes. You can visually see the hub of a network...
Line 16: Line 17:
 * ...or, set node label font size instead.  * ...or, set the font size of the node labels instead.
Line 19: Line 20:
 * Set node width and height based on label size.  * Set node widths and heights based on label size.
Line 25: Line 26:
 * Control edge transparency (opacity) by edge weights.  * Control edge transparency (opacity) using edge weights.
Line 28: Line 29:
 * Browse extremely-densed network using opacity control.  * Browse extremely-dense networks by controlling the opacity of nodes.
Line 31: Line 32:
The idea is, users can encode any attribute (name, type, degree, weight, expression data, etc.) into visual proprety such as color, size, transparency, or font type. A set of visual attribute mappings is called ''Visual Style'' and you can control it through '''''VizMapper''''' user interface. All these features are available by selecting the __View → Open VizMapper__ menu item or clicking on the Viz Mapper icon attachment:VizMapIcon.png button on the main button bar. From Cytoscape 2.5, VizMapper is a part of '''''Control Panel''''' (origially called '''''CytoPanel 1''''', the floatable panel on the left side of desktop). Instead of clicking icons or select from menu, you can directly access VizMapper by selecting tab on Control Panel.

== Introduction to VizMapper User Interface ==

In Cytoscape 2.5, VizMapper user interface is completely redesigned. There are three types of components in the new VizMapper.
The !VizMapper can be accessed by going to View → Open !VizMapper or by clicking on the !VizMapper icon attachment:VizMapIcon.png. Also, starting in Cytoscape 2.5, direct access to the !VizMapper is provided via a tab on the Control Panel at the left-hand side of the screen (formerly known as !CytoPanel 1).

== Introduction to the VizMapper User Interface ==

As of Cytoscape 2.5, the !VizMapper has undergone a complete interface redesign. There are three types of components in the new !VizMapper:
Line 40: Line 41:
    * This is the main controller for all visual styles and mappings. You can view/create/delete/switch visual styles from this panel. The table on the bottomois called '''''Visual Mapping Browser'''''. Users can directly edit discrete mappings and call ''Continuous Editors'' from this table.

 2. Default Appearence Editor
    * This panel allows you to create/delete/view/switch between different visual styles using the Current Visual Style options. The Visual Mapping Browser at the bottom displays the mapping details for a given visual style and is used to edit these details as well.

 2. Default Appearance Editor
Line 45: Line 46:
    * Users can visually edit default appearence of nodes and edges through this editor window.     * Clicking on the section labelled "Defaults" on the Main Panel will bring up this editor, which allows users to visually edit the default appearance of nodes and edges for the selected visual style.
Line 48: Line 49:
    * These are editors for continuous mapping, which is a mapping from numerical value to visual attributes. From these windows, users can edit continuous mapping more intuitively.     * These are editors for continuous mapping, which is a mapping from numerical value to visual attributes. They are accessed through the Visual Mapping Browser on the Main Panel. Using these windows, users can edit continuous mapping more intuitively.
Line 57: Line 58:
Details for these windows will be discussed in the following sections. These editors will be discussed in further detail below.
Line 62: Line 63:
 * Load a sample network: From the main menu, select __File Import Network__, and select sampleData/galFiltered.sif.
 * Layout the network: select __Layout yFiles Organic__.
 * Load a sample set of expression data: From the main menu, select __File Import Attribute Matrix__ and select sampleData/galExpData.pvals.
By default, the Visual Style labeled “default” will be automatically applied to your network. This default style has a blue background, circular pink nodes, and blue edges (see sample screenshot below).

attachment:VizMapperDefaultStyle.png '''Figure: Using the default Visual Style.'''

You can change visual styles by making a selection from the Visual Style pull down menu (available directly to the right of the attachment:VizMapIcon.png icon).

For example, if you select “Sample1”, a new visual style will be applied to your network, and you will see a white background and round blue nodes. Additionally, if you zoom in closer, you can see that protein-DNA interactions (specified with the label: pd) are drawn with dashed red edges, whereas protein-protein interactions (specified with the label: pp) are drawn with a light blue color (see sample screenshot below).

attachment:VizMapperSample1Style.png '''Figure: Using the Sample1 Visual Style. Protein-Protein interactions (solid blue lines) are now distinguishable from Protein-DNA interactions (dashed red lines).'''

Finally, if you select “Sample2”, gene expression values for each node will be colored along a color gradient between red and green (where red represents a low expression ratio, and green represents a high expression ratio - with thresholds set for the gal1RGexp experiment bundled with Cytoscape in the sampleData/galExpData.pvals file). See sample screenshot below:

 .
attachment:VizMapperSample2Style.png
'''Figure: Using the Sample2 Visual Style. Gene expression values are now displayed along a red/green color gradient.'''
'''Step 1. Load some sample data'''
* Load a sample network: From the main menu, select File → Import → Network (Multiple file types), and select {{{sampleData/galFiltered.sif}}}.
 * Layout the network: select Layout → yFiles → Organic.
 * Load a sample set of expression data: From the main menu, select File → Import → Attribute /Expression Matrix and select {{{sampleData/galExpData.pvals}}}.
By default, the Visual Style labeled “default” will be automatically applied to your network. This default style has a purple background, circular pink nodes, and blue edges (see sample screenshot below).
 attachment:VizMapperDefaultStyle.png

'''Step 2. Switch between different Visual Styles'''

You can change visual styles by making a selection from the Current Visual Style dropdown list (found at the top of the !VizMapper Main Panel).

For example, if you select “Sample1”, a new visual style will be applied to your network, and you will see a white background and round blue nodes. Additionally, if you zoom in closer, you can see that protein-DNA interactions (specified with the label "pd") are drawn with dashed red edges, whereas protein-protein interactions (specified with the label "pp") are drawn with a solid light blue edge (see sample screenshot below).
 attachment:VizMapperSample1Style.png

Finally, if you select “Sample2”, gene expression values for each node will be colored along a color gradient between red and green (where red represents a low expression ratio and green represents a high expression ratio, using thresholds set for the gal1RGexp experiment bundled with Cytoscape in the {{{sampleData/galExpData.pvals}}} file). See the sample screenshot below:
 attachment:VizMapperSample2Style.png
Line 81: Line 81:
The Cytoscape Visual Mapper has three core components: ''visual attributes, network attributes ''and ''visual mappers'':

* A ''visual attribute'' is any visual setting that can be applied to your network. For example, you can change all nodes to squares by setting the node shape visual attribute.
 * A ''network attribute'' is any attribute associated with a node or an edge. For example, each edge in a network may be associated with a label, such as “pd” (protein-DNA interactions), or “pp” (protein-protein interactions).
The Cytoscape !VizMapper uses three core concepts:
 * A ''visual attribute'' is any visual setting that can be applied to your network. For example, you can change all nodes from circles to squares by changing the node shape visual attribute.
 * A ''network attribute'' is any data attribute associated with a node or an edge. For example, each edge in a network may be associated with a label, such as “pd” (protein-DNA interactions), or “pp” (protein-protein interactions).
Line 86: Line 85:
Cytoscape includes a large number of visual attributes. These are summarized in the tables below.
||<style="text-align: center;"> '''Visual Attributes Associated with Nodes:''' ||

Cytoscape allows a wide variety of visual attributes to be controlled. These are summarized in the tables below.

||<style="text-align: center;"> '''Visual Attributes Associated with Nodes''' ||
Line 92: Line 93:
||Node Border Line Style.  Solid and Dashed lines are supported. || ||Node Border Line Style. Solid and dashed lines are supported. ||
Line 96: Line 97:
||Node Size: width and height of each node. || ||Node Size: the width and height of each node. ||
Line 100: Line 101:
||Node Label Position: the posiiton of the label relative to the node. ||
||Node Font: node font and size. ||

||<style="text-align: center;"> '''Visual Attributes Associated with Edges:''' ||
||Node Label Position: the position of the label relative to the node. ||
||Node Font: node label font and size. ||

||<style="text-align: center;"> '''Visual Attributes Associated with Edges''' ||
Line 106: Line 107:
||Edge Line Style.  Solid or Dashed line.|| ||Edge Line Style. Solid or dashed lines are supported.||
Line 109: Line 110:
|| attachment:NewVizMapperArrowType.png || ||<style="text-align: center;"> attachment:NewVizMapperArrowType.png ||
Line 115: Line 116:
||Edge Font: edge font and size. ||

||<style="text-align: center;"> '''Global Visual Properties:''' ||
||Edge Font: edge label font and size. ||

||<style="text-align: center;"> '''Global Visual Properties''' ||
Line 123: Line 124:
For each visual attribute, you can specify a default value or define a visual mapping. Cytoscape currently supports three different types of visual mappers:

 * '''Passthrough Mapper:'''
    * Network attributes are passed directly through to visual attributes. '''''A passthrough mapper only works for node/edge labels.''''' For example, a passthrough mapper can draw the common gene name on all nodes. Basically this is a mapping to specify node/edge labels.
 * '''Discrete Mapper:'''
    * Discrete network attributes are mapped to discrete visual attributes. For example, a discrete mapper can map all protein-protein interactions to the color blue.
 * '''Continuous Mapper:'''
    * Continuous graph attributes are mapped to visual attributes. Depending on the visual attribute, there are three kinds of continuous mappers:
      * '''Continuous-to-Continuous Mapper''': for example, you can map a continuous numerical value to a node size.
      * '''Color Gradient Mapper''': This is a special case of continuous-continuous mapper. Continuous nemerical values are mapped to color gradient.
      * '''Continuous-to-Discrete Mapper''': for example, all values below 0 are mapped to square nodes, and all values above 0 are mapped to circular nodes.

However, there is no way to smoothly morph between circular nodes and square nodes.
The matrix below shows visual mapper support for each visual property.
For each visual attribute, you can specify a default value or define a dynamic visual mapping. Cytoscape currently supports three different types of visual mappers:
 1. '''Passthrough Mapper'''
  * The values of network attributes are passed directly through to visual attributes. A passthrough mapper is only used to specify node/edge labels. For example, a passthrough mapper can label all nodes with their common gene names.
 2. '''Discrete Mapper'''
  * Discrete network attributes are mapped to discrete visual attributes. For example, a discrete mapper can map all protein-protein interactions to the color blue.
 3. '''Continuous Mapper'''
  * Continuous graph attributes are mapped to visual attributes. Depending on the visual attribute, there are three kinds of continuous mappers:
   i. '''Continuous-to-Continuous Mapper''': for example, you can map a continuous numerical value to a node size.
   i. '''Color Gradient Mapper''': This is a special case of continuous-to-continuous mapping. Continuous numerical values are mapped to a color gradient.
   i. '''Continuous-to-Discrete Mapper''': for example, all values below 0 are mapped to square nodes, and all values above 0 are mapped to circular nodes.
  * However, note that there is no way to smoothly morph between circular nodes and square nodes.

The table below shows visual mapper support for each visual property.

||<-2 style="text-align: center;">'''Legend'''||
||<style="text-align: center;">'''Symbol''' ||<style="text-align: center;"> '''Description''' ||
||<style="text-align: center;"> - ||Mapping is not supported for the specified visual property. ||
||<style="text-align: center;"> X ||Mapping is fully supported for the specified visual property. ||
||<style="text-align: center;"> o ||Mapping is partially supported for the specified visual property. Support for “continuous to continuous” mapping is not supported. ||
Line 174: Line 180:
 * '''Legend'''
||<style="text-align: center;">''Symbol'' ||<style="text-align: center;">''Description'' ||
||<style="text-align: center;"> - ||Mapping is not supported for specified visual property. ||
||<style="text-align: center;"> X ||Mapping is fully supported for specified visual property. ||
||<style="text-align: center;"> o ||Mapping is partially supported for specified visual property. Support for “continuous to continuous” mapping is not supported. ||
Line 181: Line 181:
The following tutorials are introduction to basic functions of VizMapper. They are independent to each other, and you can start from any of those.

=== Tutorial 1: Creating a Basic Visual Style and Set Default Values ===
The goal of this tutorial is learning how to create new Visual Style and set some default values.

 1. Load a sample network: From the main menu, select __File Import Network__, and select sampleData/galFiltered.sif.

 2. To create a new visual style, select the __View → Open Viz Mapper__ menu item, or select the Viz Mapper icon in the main button bar. You will now see a VizMapper Main Panel (shown below.)
The following tutorials demonstrate some of the basic !VizMapper features. Each tutorial is independent of the others.

=== Tutorial 1: Create a Basic Visual Style and Set Default Values ===
The goal of this tutorial is to learn how to create a new Visual Style and set some default values.

'''Step 1. Load a sample network.''' From the main menu, select File &rarr; Import &rarr; Network (Multiple file types), and select {{{sampleData/galFiltered.sif}}}.

'''Step 2. Open the !VizMapper.''' Select the View &rarr; Open !VizMapper menu option, or select the !VizMapper icon in the main button bar, or click on the !VizMapper tab in the Control Panel at the left of the screen. You will now see a !VizMapper Main Panel, as shown below.
Line 192: Line 192:
 3. Click the '''''Options''''' attachment:VizMapOptionIcon.png button, and select ''Create new visual style...'' Then enter a name for your new visual style when prompted. You will see an empty visual style in VizMapper Main Panel (shown below.) '''Step 3. Create a new visual style.''' Click the Options attachment:VizMapOptionIcon.png button, and select ''Create new visual style...'' Then enter a name for your new visual style when prompted. You will see an empty visual style in the !VizMapper Main Panel, as shown below.
Line 196: Line 196:
  Since no mapping is set up yet, all visual attributes are listed below ''Unused Properties''. From this panel, you can create node/edge mappings for all visual properties.

 4. To edit default values, open ''Default Appearence Editor'' by clicking on the '''Defaults''' graphics window (shown below.)
Since no mapping is set up yet, all visual attributes are listed in the Unused Properties category. From this panel, you can create node/edge mappings for all visual properties.

'''Step 4. Edit default values.''' Open the Default Appearance Editor by clicking on the Defaults graphics window (shown below) in the !VizMapper Main Panel.
Line 202: Line 202:
 5. For example, to set the default node shape to triangles, click '''Node Shape''' on the ''Default Visual Properties'' list. Then list of available node shapes will be shown in a window. Click ''Triangle'' icon and press ''Apply'' button. Default Appearence Editor window will be automatically updated. You can edit other default values by clicking on visual attribute names on the list. In this example, shape is set to Triangle and node color is set to blue (shown below.) '''Step 5. Change the default node shape.''' To set the default node shape to triangles, click "Node Shape" in the Default Visual Properties list. A list of available node shapes will be shown. Click on the Triangle icon and then click the Apply button. The Default Appearance Editor will be automatically updated. You can edit other default values by clicking on visual attribute names on the list. In the example shown below, the node shape is set to Triangle, while the node color is set to blue.
Line 206: Line 206:
 6. When you finish editing, hit the '''Apply''' button, available in the bottom of the editor panel. Your new Visual Style will be applied to the current network (shown below.) '''Step 6. Apply your settings.''' When you finish editing, click the Apply button at the bottom of the editor. Your new Visual Style will be applied to the current network, as shown below.
Line 211: Line 211:
The following tutorial demonstrates how to create a new visual style with a discrete mapper. The goal is to draw Protein-DNA interactions as blue-dashed lines, and Protein-Protein interactions as red-solid lines.

 1. Load a sample network: From the main menu, select __File → Import → Network__, and select sampleData/galFiltered.sif.
 2. Click the VizMapper attachment:VizMapIcon.png button on the tool bar.
 3. Press '''''Option''''' button and select ''Create new Visual Style'' to create a new Visual Style. Name your new style: “Tutorial VS2”.
 4. Double click the '''Edge Color''' cell listed below ''Unused Properties''. '''Edge Color''' cell will be moved on the top of the list. Now ''Edge Color'' is listed under ''Edge Visual Mapping'' category (shown below.)
The following tutorial demonstrates how to create a new visual style using a discrete mapper. The goal is to draw protein-DNA interactions as dashed blue lines, and protein-protein interactions as solid red lines.

'''Step 1. Load a sample network.''' From the main menu, select File &rarr; Import &rarr; Network (Multiple file types), and select {{{sampleData/galFiltered.sif}}}.

'''Step 2. Open the !VizMapper.''' Select the View &rarr; Open !VizMapper menu option, or select the !VizMapper icon in the main button bar, or click on the !VizMapper tab in the Control Panel at the left of the screen.

'''Step 3. Create a new visual style.''' Click the Options attachment:VizMapOptionIcon.png button, and select ''Create new visual style...'' Name your new style “Tutorial VS2”.

'''Step 4. Choose a visual attribute.''' Double click the Edge Color entry listed in Unused Properties. Edge Color will now appear at the top of the list, under the Edge Visual Mapping category (as shown below).
Line 220: Line 223:
 5. Select ''interaction'' from the pull-down menu in the cell next to ''Edge Color''.
 6. Select ''Discrete Mapping'' for ''Mapping Type''. Then all available attribute values for ''interaction'' will be displayed (shown below.)
'''Step 5. Choose a network attribute.''' Click on the cell to the right of the Edge Color entry and select "interaction" from the dropdown list that appears.

'''Step 6. Choose a mapping type.''' Set the Discrete Mapper option as the Mapping Type. All available attribute values for "interaction" will be displayed, as shown below.
Line 225: Line 229:
 7. Click the cell empty cell next to ''pd'' (Protein-DNA interactions). On the right side of the cell, '''''...''''' and '''''X''''' will appear. '''Step 7. Set the mapping relationship.''' Click the empty cell next to "pd" (protein-DNA interactions). On the right side of the cell, '''...''' and '''X''' buttons will appear. Click on the '''...''' button. A popup window will appear; select blue, and the change will immediately appear on the network window.
Line 229: Line 233:
 8. Click on '''''...''''' button. Popup window will appear and you can select blue from the dialog.
 9. The change immediately appears on the network window.
 10. Repeat 7-8 for ''pp'' (Protein-Protein interactions). For ''pp'', select red instead.
 11. Repeat 4-10 for ''Edge Line Style''. For ''Edge Line Style'', you can select line style (dashed or solid) from pull-down menu.

Now your network should show ''pd'' interactions as blue-dashed lines, and ''pp'' interactions as red-solid lines. (Sample screenshot is below.)
Repeat step 7 for "pp" (protein-protein interactions), but select red as the edge color. Then repeat steps 4 through 7 for the Edge Line Style attribute. You can select the correct line style (dashed or solid) from the dropdown list.

 attachment:EdgeMapping3.png

Now your network should show "pd" interactions as dashed blue lines and "pp" interactions as solid red lines. A sample screenshot is provided below.
Line 239: Line 242:
The following tutorial demonstrates how to create a new continuous mapper. The goal is to superimpose gene expression data onto a network, and to display gene expression values along a color gradient.

 * Load a sample network: From the main menu, select __File → Import → Network__, and select sampleData/galFiltered.sif.
 * Load a sample set of expression data: From the main menu, select __File → Import → Attribute Matrix__ and select sampleData/galExpData.pvals.
 * Click the VizMap attachment:VizMapIcon.png button on the tool bar.
 * Select “New” to create a new Visual Style. Name your new style: “Sample4”.
 * Click the “Define” button to define the newly created Visual Style.
 * In the “Set Visual Properties” Dialog box, select __Node Attributes → Node Color__.
 * Click the New button in the mapping panel.
 * You will be prompted to select a mapping type: passthrough mapper, discrete mapper or continuous mapper (for an overview of the differences between these mappers, please refer to the section above) Select “continuous mapper”, and enter a descriptive name. For example, enter: Color_Gradient.
 * From the “Map Attribute” pull-down menu, select “gal1RGexp.”
 * Click the “Add Point” button twice to add two data points.
 * Set the first point to “-1”, Below = Yellow, Equal = White.
 * Set the second point to “2”, Equal = Red, Above = Black.
 * Click the “Apply to Network" button.
This visual mapper will set all nodes with a gal1RGexp value less than –1 to Yellow, and all nodes with a gal1RGExp value greater than 2 to Black. Additionally, all values between –1 and 2 will be painted with a white/red color gradient. Sample screenshot is below.
The following tutorial demonstrates how to create a new visual style using a continuous mapper. The goal is to superimpose gene expression data onto a network and display gene expression values along a color gradient.

'''Step 1. Load a sample network.''' From the main menu, select File &rarr; Import &rarr; Network (Multiple file types), and select {{{sampleData/galFiltered.sif}}}.

''' Step 2. Load sample expression data.''' From the main menu, select File &rarr; Import &rarr; Attribute/Expression Matrix, and select {{{sampleData/galExpData/pvals}}}.

'''Step 3. Open the !VizMapper.''' Select the View &rarr; Open !VizMapper menu option, or select the !VizMapper icon in the main button bar, or click on the !VizMapper tab in the Control Panel at the left of the screen.

'''Step 4. Create a new visual style.''' Click the Options attachment:VizMapOptionIcon.png button, and select ''Create new visual style...'' Name your new style “Tutorial VS3”.

'''Step 5. Choose a visual attribute.''' Double click the Node Color entry listed in Unused Properties. Node Color will now appear at the top of the list, under the Node Visual Mapping category.

'''Step 6. Choose a network attribute.''' Click on the cell to the right of the Node Color entry and select "gal1RGexp" from the dropdown list that appears.

'''Step 7. Choose a mapping type.''' Set the Continuous Mapping option as the Mapping Type.

'''Step 8. Define the points where colors will change.''' Double-click on the white rectangle next to Graphical View to open the Color Gradient Mapper. Click the Add button twice to create two data points, which will show up as overlapping triangles at the right of the scale. Click and drag one point to -1, or type the value in the Range Setting box. Set the second point to 2.

'''Step 9. Define the colors between points.''' Double-click on the leftmost triangle (facing left) and a color palette will appear. Choose a shade of yellow and click OK. Leave the triangle at -1 white. Double-click on the triangle set at 2, and set its color to red. Set the rightmost triangle to black.

 attachment:colorgradient.png

The color gradients will immediately appear in the network window. All nodes with a gal1RGexp value less than –1 will be set to yellow, and all nodes with a gal1RGExp value greater than 2 will be black. Additionally, all values between –1 and 2 will be painted with a white/red color gradient. A sample screenshot is below.
Line 259: Line 269:
(Under construction!)

The following tutorial demonstrats new features in Cytoscape 2.5. The new VizMapper user interface some utilities to help users editing discrete mappings. The goal of this section is learning how to set and adjust values for discrete mappings automatically.
The following tutorial demonstrates new features in Cytoscape 2.5. The new VizMapper user interface has some utilities to help users editing discrete mappings. The goal of this section is learning how to set and adjust values for discrete mappings automatically.
Line 265: Line 273:

attachment:CircleLayout1.png
Line 269: Line 274:
 4. Click ''Defaults'' panel on the VizMapper main panel. Default Appearence Editor pops up (see below.)

attachment:DefaultEditor.png
 4. Click ''Defaults'' panel on the VizMapper main panel. Default Apearence Editor pops up (see below.)
Line 278: Line 280:
attachment:Opacity1.png

 6. Cretate a '''Discrete Node Color Mapping'''. Click on the
 attachment:Opacity1.png

 6. Cretate a '''Discrete Node Color Mapping'''. Select ''Degree'' as controlling attribute.
 7. Select '''Node Color''', then right click to show popup menu. Select __Generate discrete values → Rainbow 1__. It generates different colors for different attribute values as shown below.

 attachment:Rainbow1.png
 

 8. Cretate a '''Discrete Node Size Mapping'''. Select ''Degree'' as controlling attribute.
 9. Select '''Node Size''' and right click to show popup menu. Select __Generate Discrete Values → Series (Numbers Only)__. Type ''30'' for the first value and click OK. Enter ''15'' for increment.
 10. Apply Force-Directed layout. Final view of the window looks like the following.

 attachment:tutorial4_last.png
Line 308: Line 321:
All Cytoscape Visual Style settings are initially loaded from a a default file called vizmap.props that cannot be altered by users. When users make changes to the visual properties, a vizmap.props file is saved in the session file. This means that assuming you save your session, you will not lose your visual properties.  No other vizmap.props files are saved during normal operation. All Cytoscape Visual Style settings are initially loaded from a a default file called {{{vizmap.props}}} that cannot be altered by users. When users make changes to the visual properties, a {{{vizmap.props}}} file is saved in the session file. This means that assuming you save your session, you will not lose your visual properties. No other {{{vizmap.props}}} files are saved during normal operation.
Line 311: Line 324:
Visual styles are automatically saved with the session they were created in.  Before Cytoscape exits, you will be prompted to make sure you save the session before quitting.   It is also possible to save your visual styles in a file separate from the session file.  To do this, navigate to the __File Export Vizmap Property File...__ menu and choose the file the properties should be saved to. This feature can be used to share visual styles with other users. Visual styles are automatically saved with the session they were created in. Before Cytoscape exits, you will be prompted to make sure you save the session before quitting. It is also possible to save your visual styles in a file separate from the session file. To do this, navigate to the File &rarr; Export &rarr; Vizmap Property File menu option and save the properties as a file. This feature can be used to share visual styles with other users.
Line 314: Line 327:
To import existing visual styles navigate to the __File Import Vizmap Property File__ menu option and select a vizmap.props file. Imported properties will supplement existing properties or override existing properties if the properties have the same name. You can also specify a visual properties file using the -V command line option (cytoscape.sh -V myVizmap.props). Visual properties loaded from the command line will override any default properties. To import existing visual styles, navigate to the File &rarr; Import &rarr; Vizmap Property File menu option and select a {{{vizmap.props}}} file. Imported properties will supplement existing properties or override existing properties if the properties have the same name. You can also specify a visual properties file using the -V command line option ({{{cytoscape.sh -V myVizmap.props}}}). Visual properties loaded from the command line will override any default properties.
Line 317: Line 330:
It is possible to change the default visual properties for all sessions of cytoscape. To do this, navigate to the __Edit Preferences...__ menu, check the "Make Current Visual Styles Default" box in the "Default Visual Styles" section, and click "Ok". This will save the current visual styles as a vizmap.props file to your .cytoscape directory (found in your home directory). These visual styles will be loaded each time Cytoscape is started.

== Bypassing Visual Styles ==
Cytoscape has a new feature that allows users to override visualizations created by the vizmapper for individual nodes and edges. This feature is available by right-clicking on a node or edge and then clicking on the __Visual Mapping Bypass__ menu.

attachment:VizmapBypass.png

Each visual property of the node or edge is displayed. When a property is overridden, a checkmark appears next to the property and a __[Reset <Property Name>]__ menu item appears below the checked property. By clicking the __[Reset <Property Name>]__ option the bypass will be removed and the attribute will be displayed as defined by the VizMapper. At the bottom of the menu a __Reset All__ option appears. When clicked, this will be remove all bypasses for the specified node or edge. In the example above you can see the the selected node size, color, and shape have been overridden. This is apparent in the appearance of the node itself and by the check marks in the popup menu.

It is important to realize that the the Visual Mapping Bypass only works for individual nodes and edges and not for all nodes or edges of a specific type. Using bypass is not particularly resource intensive, meaning you can use it as much as you like. However, if you ever find yourself repeating the same bypasses, then you should consider using the VizMapper instead.

Bypass is accomplished using special attributes with names like ''node.fillColor'' and ''node.shape''. These are normal Cytoscape attributes and can be seen an editted in the Attribute Browser. The value of the attribute is a string representation of a property. For example, color is represented by 3 integers representing the RGB (red, green, blue) value of the color. Different types of properties have different string representations. When in doubt, just use the right click menu to create valid attribute values.

Because bypass values are specified using normal attributes, these attributes will persist between sessions as long as you save your session! If you don't save your session, you will lose whatever bypass values you set.
It is possible to change the default visual properties for all sessions of Cytoscape. To do this, navigate to the Edit &rarr; Preferences &rarr; Properties... menu option, check the "Make Current Visual Styles Default" box in the Default Visual Styles section, and click the OK button. This will save the current visual styles as a {{{vizmap.props}}} file to your {{{.cytoscape}}} directory (found in your home directory). These visual styles will then be loaded each time Cytoscape is started.

=== Bypassing Visual Styles ===
Cytoscape has a feature that allows users to override visualizations created by the !VizMapper for individual nodes and edges. This feature is available by right-clicking on a node or edge and then clicking on the Visual Mapping Bypass menu.
 attachment:VizmapBypass.png
Each visual property of the node or edge is displayed. When a property is overridden, a checkmark appears next to the property and a [Reset <Property Name>] menu option appears directly below it. By clicking this Reset option, the bypass will be removed and the attribute will be displayed as defined by the !VizMapper. At the bottom of the menu a Reset All option appears. When clicked, this will remove all bypasses for the specified node or edge. In the example above, you can see the the selected node size, color, and shape have been overridden. This is apparent in the appearance of the node itself and by the check marks in the popup menu.

It is important to realize that the the Visual Mapping Bypass only works for individual nodes and edges and not for all nodes or edges of a specific type. Using the bypass function is not particularly resource intensive, meaning you can use it as much as you like. However, if you ever find yourself repeating the same bypasses, then you should consider using the !VizMapper instead.

Bypass is accomplished using special attributes with names like {{{node.fillColor}}} and {{{node.shape}}}. These are normal Cytoscape attributes and can be seen and edited in the Attribute Browser. The value of the attribute is a string representation of a property. For example, color is represented by 3 integers representing the RGB (red, green, blue) value of the color. Different types of properties have different string representations. When in doubt, just use the right click menu to create valid attribute values.

Because bypass values are specified using normal attributes, these attributes will persist between sessions only as long as you save your session! If you don't save your session, you will lose whatever bypass values you set.

What is a Visual Style?

One of Cytoscape's strengths in network visualization is the ability to allow users to encode any attribute of their data (name, type, degree, weight, expression data, etc.) as a visual property (such as color, size, transparency, or font type). A set of these encoded or mapped attributes is called a Visual Style and can be created or edited using the Cytoscape VizMapper. With the VizMapper, the visual appearance of your network is easily customized. For example, you can:

  • Specify a default color and shape for all nodes.
  • Use specific line types to indicate different types of interactions.
  • Encode specific physical entities as different node shapes.
  • Set node sizes based on the degree of connectivity of the nodes. You can visually see the hub of a network...
  • ...or, set the font size of the node labels instead.
  • Set node widths and heights based on label size.
  • Visualize gene expression data along a color gradient.
  • Control edge transparency (opacity) using edge weights.
  • Browse extremely-dense networks by controlling the opacity of nodes.

The VizMapper can be accessed by going to View → Open VizMapper or by clicking on the VizMapper icon attachment:VizMapIcon.png. Also, starting in Cytoscape 2.5, direct access to the VizMapper is provided via a tab on the Control Panel at the left-hand side of the screen (formerly known as CytoPanel 1).

Introduction to the VizMapper User Interface

As of Cytoscape 2.5, the VizMapper has undergone a complete interface redesign. There are three types of components in the new VizMapper:

  1. Main Panel
    • attachment:VizMapperMainPanel.png

    • This panel allows you to create/delete/view/switch between different visual styles using the Current Visual Style options. The Visual Mapping Browser at the bottom displays the mapping details for a given visual style and is used to edit these details as well.
  2. Default Appearance Editor
    • attachment:DefaultEditorPanel.png

    • Clicking on the section labelled "Defaults" on the Main Panel will bring up this editor, which allows users to visually edit the default appearance of nodes and edges for the selected visual style.
  3. Continuous Editors
    • These are editors for continuous mapping, which is a mapping from numerical value to visual attributes. They are accessed through the Visual Mapping Browser on the Main Panel. Using these windows, users can edit continuous mapping more intuitively.
    • Color Gradient Editor
    • Continuous-to-Discrete Editor
      • attachment:C2DPanel.png
    • Continuous-to-Continuous Editor
      • attachment:C2CPanel.png

These editors will be discussed in further detail below.

Introduction to Visual Styles

The Cytoscape distribution includes several predefined visual styles to get you started. To demonstrate these styles, try out the following example:

Step 1. Load some sample data

  • Load a sample network: From the main menu, select File → Import → Network (Multiple file types), and select sampleData/galFiltered.sif.

  • Layout the network: select Layout → yFiles → Organic.

  • Load a sample set of expression data: From the main menu, select File → Import → Attribute /Expression Matrix and select sampleData/galExpData.pvals.

By default, the Visual Style labeled “default” will be automatically applied to your network. This default style has a purple background, circular pink nodes, and blue edges (see sample screenshot below).

Step 2. Switch between different Visual Styles

You can change visual styles by making a selection from the Current Visual Style dropdown list (found at the top of the VizMapper Main Panel).

For example, if you select “Sample1”, a new visual style will be applied to your network, and you will see a white background and round blue nodes. Additionally, if you zoom in closer, you can see that protein-DNA interactions (specified with the label "pd") are drawn with dashed red edges, whereas protein-protein interactions (specified with the label "pp") are drawn with a solid light blue edge (see sample screenshot below).

Finally, if you select “Sample2”, gene expression values for each node will be colored along a color gradient between red and green (where red represents a low expression ratio and green represents a high expression ratio, using thresholds set for the gal1RGexp experiment bundled with Cytoscape in the sampleData/galExpData.pvals file). See the sample screenshot below:

Visual Attributes, Graph Attributes and Visual Mappers

The Cytoscape VizMapper uses three core concepts:

  • A visual attribute is any visual setting that can be applied to your network. For example, you can change all nodes from circles to squares by changing the node shape visual attribute.

  • A network attribute is any data attribute associated with a node or an edge. For example, each edge in a network may be associated with a label, such as “pd” (protein-DNA interactions), or “pp” (protein-protein interactions).

  • A visual mapper maps network attributes to visual attributes. For example, a visual mapper can map all protein-DNA interactions to the color blue, and all protein-protein interactions to the color red.

Cytoscape allows a wide variety of visual attributes to be controlled. These are summarized in the tables below.

Visual Attributes Associated with Nodes

Node Color

Node Opacity

Node Border Color

Node Border Opacity

Node Border Line Style. Solid and dashed lines are supported.

Node Border Line Width

Node Shape. The following options are available:

attachment:NewVizMapperNodeShape.png

Node Size: the width and height of each node.

Node Label: the text label for each node.

Node Label Color

Node Label Opacity

Node Label Position: the position of the label relative to the node.

Node Font: node label font and size.

Visual Attributes Associated with Edges

Edge Color

Edge Opacity

Edge Line Style. Solid or dashed lines are supported.

Edge Line Width

Edge Source and Target Arrow Shape: The following options are available:

attachment:NewVizMapperArrowType.png

Edge Source and Target Arrow Color

Edge Source and Target Arrow Opacity

Edge Label: the text label for each edge.

Edge Label Color

Edge Label Opacity

Edge Font: edge label font and size.

Global Visual Properties

Background Color

Selected Node Color

Selected Edge Color

For each visual attribute, you can specify a default value or define a dynamic visual mapping. Cytoscape currently supports three different types of visual mappers:

  1. Passthrough Mapper

    • The values of network attributes are passed directly through to visual attributes. A passthrough mapper is only used to specify node/edge labels. For example, a passthrough mapper can label all nodes with their common gene names.
  2. Discrete Mapper

    • Discrete network attributes are mapped to discrete visual attributes. For example, a discrete mapper can map all protein-protein interactions to the color blue.
  3. Continuous Mapper

    • Continuous graph attributes are mapped to visual attributes. Depending on the visual attribute, there are three kinds of continuous mappers:
      1. Continuous-to-Continuous Mapper: for example, you can map a continuous numerical value to a node size.

      2. Color Gradient Mapper: This is a special case of continuous-to-continuous mapping. Continuous numerical values are mapped to a color gradient.

      3. Continuous-to-Discrete Mapper: for example, all values below 0 are mapped to square nodes, and all values above 0 are mapped to circular nodes.

    • However, note that there is no way to smoothly morph between circular nodes and square nodes.

The table below shows visual mapper support for each visual property.

Legend

Symbol

Description

-

Mapping is not supported for the specified visual property.

X

Mapping is fully supported for the specified visual property.

o

Mapping is partially supported for the specified visual property. Support for “continuous to continuous” mapping is not supported.

Node Visual Mappings

Node Visual Properties

Passthrough Mapper

Discrete Mapper

Continuous Mapper

Color

Node Color

-

X

X

Node Opacity

-

X

X

Node Border Color

-

X

X

Node Border Opacity

-

X

X

Node Label Color

-

X

X

Node Label Opacity

-

X

X

Numeric

Node Size

-

X

X

Node Font Size

-

X

X

Node Line Width

-

X

X

Other

Node Border Type

-

X

o

Node Shape

-

X

o

Node Label

X

X

o

Node Tooltip

X

X

o

Node Font Family

-

X

o

Edge Visual Mappings

Edge Properties

Passthrough Mapper

Discrete Mapper

Continuous Mapper

Color

Edge Color

-

X

X

Edge Opacity

-

X

X

Edge Target Arrow Color

-

X

X

Edge Source Arrow Color

-

X

X

Edge Target Arrow Opacity

-

X

X

Edge Source Arrow Opacity

-

X

X

Edge Label Color

-

X

X

Edge Label Opacity

-

X

X

Numeric

Edge Line Width

-

X

X

Edge Font Size

-

X

X

Other

Edge Line Type

-

X

o

Edge Source Arrow Shape

-

X

o

Edge Target Arrow Shape

-

X

o

Edge Label

X

X

o

Edge Tooltip

X

X

o

Edge Font Family

-

X

o

Visual Styles Tutorials

The following tutorials demonstrate some of the basic VizMapper features. Each tutorial is independent of the others.

Tutorial 1: Create a Basic Visual Style and Set Default Values

The goal of this tutorial is to learn how to create a new Visual Style and set some default values.

Step 1. Load a sample network. From the main menu, select File → Import → Network (Multiple file types), and select sampleData/galFiltered.sif.

Step 2. Open the VizMapper. Select the View → Open VizMapper menu option, or select the VizMapper icon in the main button bar, or click on the VizMapper tab in the Control Panel at the left of the screen. You will now see a VizMapper Main Panel, as shown below.

Step 3. Create a new visual style. Click the Options attachment:VizMapOptionIcon.png button, and select Create new visual style... Then enter a name for your new visual style when prompted. You will see an empty visual style in the VizMapper Main Panel, as shown below.

Since no mapping is set up yet, all visual attributes are listed in the Unused Properties category. From this panel, you can create node/edge mappings for all visual properties.

Step 4. Edit default values. Open the Default Appearance Editor by clicking on the Defaults graphics window (shown below) in the VizMapper Main Panel.

Step 5. Change the default node shape. To set the default node shape to triangles, click "Node Shape" in the Default Visual Properties list. A list of available node shapes will be shown. Click on the Triangle icon and then click the Apply button. The Default Appearance Editor will be automatically updated. You can edit other default values by clicking on visual attribute names on the list. In the example shown below, the node shape is set to Triangle, while the node color is set to blue.

Step 6. Apply your settings. When you finish editing, click the Apply button at the bottom of the editor. Your new Visual Style will be applied to the current network, as shown below.

Tutorial 2: Creating a New Visual Style with a Discrete Mapper

The following tutorial demonstrates how to create a new visual style using a discrete mapper. The goal is to draw protein-DNA interactions as dashed blue lines, and protein-protein interactions as solid red lines.

Step 1. Load a sample network. From the main menu, select File → Import → Network (Multiple file types), and select sampleData/galFiltered.sif.

Step 2. Open the VizMapper. Select the View → Open VizMapper menu option, or select the VizMapper icon in the main button bar, or click on the VizMapper tab in the Control Panel at the left of the screen.

Step 3. Create a new visual style. Click the Options attachment:VizMapOptionIcon.png button, and select Create new visual style... Name your new style “Tutorial VS2”.

Step 4. Choose a visual attribute. Double click the Edge Color entry listed in Unused Properties. Edge Color will now appear at the top of the list, under the Edge Visual Mapping category (as shown below).

Step 5. Choose a network attribute. Click on the cell to the right of the Edge Color entry and select "interaction" from the dropdown list that appears.

Step 6. Choose a mapping type. Set the Discrete Mapper option as the Mapping Type. All available attribute values for "interaction" will be displayed, as shown below.

Step 7. Set the mapping relationship. Click the empty cell next to "pd" (protein-DNA interactions). On the right side of the cell, ... and X buttons will appear. Click on the ... button. A popup window will appear; select blue, and the change will immediately appear on the network window.

Repeat step 7 for "pp" (protein-protein interactions), but select red as the edge color. Then repeat steps 4 through 7 for the Edge Line Style attribute. You can select the correct line style (dashed or solid) from the dropdown list.

Now your network should show "pd" interactions as dashed blue lines and "pp" interactions as solid red lines. A sample screenshot is provided below.

attachment:NewVizMapperInteractionsRedBlue.png

Tutorial 3: Visualizing Expression Data on a Network

The following tutorial demonstrates how to create a new visual style using a continuous mapper. The goal is to superimpose gene expression data onto a network and display gene expression values along a color gradient.

Step 1. Load a sample network. From the main menu, select File → Import → Network (Multiple file types), and select sampleData/galFiltered.sif.

Step 2. Load sample expression data. From the main menu, select File → Import → Attribute/Expression Matrix, and select sampleData/galExpData/pvals.

Step 3. Open the VizMapper. Select the View → Open VizMapper menu option, or select the VizMapper icon in the main button bar, or click on the VizMapper tab in the Control Panel at the left of the screen.

Step 4. Create a new visual style. Click the Options attachment:VizMapOptionIcon.png button, and select Create new visual style... Name your new style “Tutorial VS3”.

Step 5. Choose a visual attribute. Double click the Node Color entry listed in Unused Properties. Node Color will now appear at the top of the list, under the Node Visual Mapping category.

Step 6. Choose a network attribute. Click on the cell to the right of the Node Color entry and select "gal1RGexp" from the dropdown list that appears.

Step 7. Choose a mapping type. Set the Continuous Mapping option as the Mapping Type.

Step 8. Define the points where colors will change. Double-click on the white rectangle next to Graphical View to open the Color Gradient Mapper. Click the Add button twice to create two data points, which will show up as overlapping triangles at the right of the scale. Click and drag one point to -1, or type the value in the Range Setting box. Set the second point to 2.

Step 9. Define the colors between points. Double-click on the leftmost triangle (facing left) and a color palette will appear. Choose a shade of yellow and click OK. Leave the triangle at -1 white. Double-click on the triangle set at 2, and set its color to red. Set the rightmost triangle to black.

  • attachment:colorgradient.png

The color gradients will immediately appear in the network window. All nodes with a gal1RGexp value less than –1 will be set to yellow, and all nodes with a gal1RGExp value greater than 2 will be black. Additionally, all values between –1 and 2 will be painted with a white/red color gradient. A sample screenshot is below.

attachment:VizMapperExpRedBlack.png

Tutorial 4: How to Use Utilities for Discrete Mappers

The following tutorial demonstrates new features in Cytoscape 2.5. The new VizMapper user interface has some utilities to help users editing discrete mappings. The goal of this section is learning how to set and adjust values for discrete mappings automatically.

  1. Load a sample network: From the main menu, select File → Import → Network, and select sampleData/galFiltered.sif.

  2. Apply layout to the network: From the main menu, select Layout → Cytoscape Layouts → Degree Sorted Circle Layout. This layout algorithm sort nodes in a circle by degree of the nodes. Degrees will be stored as node attribute names Degree after you applied this algorithm.

  3. Click the VizMap attachment:VizMapIcon.png button on the tool bar.

  4. Click Defaults panel on the VizMapper main panel. Default Apearence Editor pops up (see below.)

  5. Edit the following visual properties and press Apply. Since you changed opacity of the node, you can see the nodes bihind the front node (see below.)

    • Node Oppacity - 100
    • Edge Color - White
    • Background Color - Black
    attachment:Opacity1.png
  6. Cretate a Discrete Node Color Mapping. Select Degree as controlling attribute.

  7. Select Node Color, then right click to show popup menu. Select Generate discrete values → Rainbow 1. It generates different colors for different attribute values as shown below. attachment:Rainbow1.png

  8. Cretate a Discrete Node Size Mapping. Select Degree as controlling attribute.

  9. Select Node Size and right click to show popup menu. Select Generate Discrete Values → Series (Numbers Only). Type 30 for the first value and click OK. Enter 15 for increment.

  10. Apply Force-Directed layout. Final view of the window looks like the following. attachment:tutorial4_last.png

Advanced Topics

Editing Discrete Mappings

From version 2.5, several utility functions are available for Discrete Mappings. You can use those functions by right clicking anywhere on the Visual Mapping Browser (shown below.)

attachment:VizMapperPopupMenu.png

Automatic Value Generators

  • Generate Discrete Values - Functions in this menu category are value generator for discrete mappings. Users can set values for discrete mappings automatically by these functions.

    • Rainbow 1 and Rainbow 2 - These

  • Modify Discrete Values

Edit Selected Values at Once

Working with Continuous Mapping Editors

There are three kinds of Continuous Mapping Editors. Each of them are associated with a specific visual attributes:

Editor Type

Supported Data Type

Visual Attributes

Color Gradient Editor

Color

node/edge/border/label colors

Continuous-Continuous Editor

Numbers

size/width/opacity

Continuous-Discrete Editor

Managing Visual Styles

All Cytoscape Visual Style settings are initially loaded from a a default file called vizmap.props that cannot be altered by users. When users make changes to the visual properties, a vizmap.props file is saved in the session file. This means that assuming you save your session, you will not lose your visual properties. No other vizmap.props files are saved during normal operation.

Saving Visual Styles

Visual styles are automatically saved with the session they were created in. Before Cytoscape exits, you will be prompted to make sure you save the session before quitting. It is also possible to save your visual styles in a file separate from the session file. To do this, navigate to the File → Export → Vizmap Property File menu option and save the properties as a file. This feature can be used to share visual styles with other users.

Importing Visual Styles

To import existing visual styles, navigate to the File → Import → Vizmap Property File menu option and select a vizmap.props file. Imported properties will supplement existing properties or override existing properties if the properties have the same name. You can also specify a visual properties file using the -V command line option (cytoscape.sh -V myVizmap.props). Visual properties loaded from the command line will override any default properties.

Default Visual Styles

It is possible to change the default visual properties for all sessions of Cytoscape. To do this, navigate to the Edit → Preferences → Properties... menu option, check the "Make Current Visual Styles Default" box in the Default Visual Styles section, and click the OK button. This will save the current visual styles as a vizmap.props file to your .cytoscape directory (found in your home directory). These visual styles will then be loaded each time Cytoscape is started.

Bypassing Visual Styles

Cytoscape has a feature that allows users to override visualizations created by the VizMapper for individual nodes and edges. This feature is available by right-clicking on a node or edge and then clicking on the Visual Mapping Bypass menu.

Each visual property of the node or edge is displayed. When a property is overridden, a checkmark appears next to the property and a [Reset <Property Name>] menu option appears directly below it. By clicking this Reset option, the bypass will be removed and the attribute will be displayed as defined by the VizMapper. At the bottom of the menu a Reset All option appears. When clicked, this will remove all bypasses for the specified node or edge. In the example above, you can see the the selected node size, color, and shape have been overridden. This is apparent in the appearance of the node itself and by the check marks in the popup menu.

It is important to realize that the the Visual Mapping Bypass only works for individual nodes and edges and not for all nodes or edges of a specific type. Using the bypass function is not particularly resource intensive, meaning you can use it as much as you like. However, if you ever find yourself repeating the same bypasses, then you should consider using the VizMapper instead.

Bypass is accomplished using special attributes with names like node.fillColor and node.shape. These are normal Cytoscape attributes and can be seen and edited in the Attribute Browser. The value of the attribute is a string representation of a property. For example, color is represented by 3 integers representing the RGB (red, green, blue) value of the color. Different types of properties have different string representations. When in doubt, just use the right click menu to create valid attribute values.

Because bypass values are specified using normal attributes, these attributes will persist between sessions only as long as you save your session! If you don't save your session, you will lose whatever bypass values you set.

Cytoscape_User_Manual/Visual_Styles (last edited 2010-10-16 18:19:48 by cosiapat1)

Funding for Cytoscape is provided by a federal grant from the U.S. National Institute of General Medical Sciences (NIGMS) of the Na tional Institutes of Health (NIH) under award number GM070743-01. Corporate funding is provided through a contract from Unilever PLC.

MoinMoin Appliance - Powered by TurnKey Linux