Differences between revisions 6 and 19 (spanning 13 versions)
Revision 6 as of 2007-01-09 23:27:42
Size: 7860
Editor: nebbiolo
Comment:
Revision 19 as of 2008-03-24 21:46:18
Size: 7632
Editor: KeiichiroOno
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
attachment:cytoscape_startup_network.png attachment:cytoscape_startup_network_26.png
Line 7: Line 7:
 1. The menu bar at the top (See below for more information about each menu).
 1. The toolbar, which contains icons for commonly used functions. These functions are also available via the menus. Hover the mouse pointer over an icon and wait momentarily for a description to appear as a tooltip.
 1. The network management panel (top-left ). This contains an optional network overview pane (bottom-left overview of the network).
 1. The main network view window, which displays the network.
 1.
The attribute browser panel (bottom panel), which displays attributes of selected nodes and edges and enables you to modify the values of attributes.
The network management and attribute browser panels are dockable tabbed panels known as !CytoPanels. You can undock any of these panels by clicking on the Float Window control in the upper-right corner of the !CytoPanel.
 * The menu bar at the top (see below for more information about each menu).
 * The toolbar, which contains icons for commonly used functions. These functions are also available via the menus. Hover the mouse pointer over an icon and wait momentarily for a description to appear as a tooltip.
 * The network management panel (top left panel). This contains an optional network overview pane (shown at the bottom left).
 * The main network
view window, which displays the network.
 * The attribute browser panel (bottom panel), which displays attributes of selected nodes and edges and enables you to modify the values of attributes.
The network management and attribute browser panels are dockable tabbed panels known as !CytoPanels. You can undock any of these panels by clicking on the Float Window control attachment:float_icon.png in the upper-right corner of the !CytoPanel.
Line 14: Line 14:
attachment:float_icon.png
If you select this control, e.g. on the attribute browser panel, you will now have two Cytoscape windows, the main window, and a new window labeled !CytoPanel 2, similar to the one shown below.
If you select this control, e.g. on the attribute browser panel, you will now have two Cytoscape windows, the main window, and a new window labeled !CytoPanel 2, similar to the one shown below.  Popup will be displayed when you put the mouse pointer on a cell.
Line 17: Line 16:
attachment:attribute_browser_nodes.png  attachment:attribute_browser_26.png
Line 20: Line 20:
Cytoscape also has an editor that enables you to build and modify networks interactively by dragging and dropping nodes and edges from a palette onto the main network view window. The Node shapes and Edge arrows on the palette are defined by the currently used Visual Style. To edit a network, just select the Editor tab on !CytoPanel 1. An example of an editor, with the palette contained in !CytoPanel 1 and defined by the Bio''''''Molecule''''''Editor Visual Style, is shown below. Cytoscape also has an editor that enables you to build and modify networks interactively by dragging and dropping nodes and edges from a palette onto the main network view window. The Node shapes and Edge arrows on the palette are defined by the currently used Visual Style. To edit a network, just select the Editor tab on !CytoPanel 1. An example of an editor, with the palette contained in !CytoPanel 1 and defined by the !BioMoleculeEditor Visual Style, is shown below.
    attachment:editor_25.png
Line 22: Line 24:
attachment:editor1.png
Line 26: Line 27:
'''File''' The __File__ menu contains most basic file functionality: __File → Open__ for opening a Cytoscape session file, __File → Save__ for saving a session file, __File → Import__ for importing data such as networks and attributes, __File → Export__ for exporting data and images.  __File → Print__ allows printing. __File → Quit__ closes all windows of Cytoscape and exits the program. __File → New __ creates a new network, either blank for editing, or from an existing network. === File ===
The File menu contains most basic file functionality: File → Open for opening a Cytoscape session file; File → New for creating a new network, either blank for editing, or from an existing network; File → Save for saving a session file; File → Import for importing data such as networks and attributes; and File → Export for exporting data and images. Also, File → Print allows printing, while File → Quit closes all windows of Cytoscape and exits the program.
Line 28: Line 30:
attachment:menu_file.png  attachment:menu_file_26.png
Line 30: Line 32:
'''Edit''' The __Edit__ menu contains Undo and Redo menu items which undo and redo edits made in the Attribute Browser and the Network Editor '''ONLY'''. ''Undo and Redo support do ''NOT'' work for other actions in Cytoscape such as layout.''
 
There are also options for creating and destroying views (graphical representations of a network) and networks (the network data – not yet visualized), as well as an option for deleting selected nodes and edges from the current network. All deleted nodes and edges can be restored to the network via the __Edit → Undo__ menu item. The __Edit__ Menu also supports Preferences editing for properties and plug-ins via a Preferences Dialog.
=== Edit ===
The Edit menu contains Undo and Redo functions which undo and redo edits made in the Attribute Browser, the Network Editor and to layout.
Line 34: Line 35:
attachment:menu_edit.png There are also options for creating and destroying views (graphical representations of a network) and networks (the raw network data – not yet visualized), as well as an option for deleting selected nodes and edges from the current network. All deleted nodes and edges can be restored to the network via Edit → Undo. Editing preferences for properties and plugins is found under Edit → Preferences → Properties... .
Line 36: Line 37:
'''View''' The __View__ menu allows you to display or hide the network management panel (!CytoPanel 1), the attribute browser (!CytoPanel 2), the Network Overview (in !CytoPanel 1), and the Advanced window. The __View__ menu also allows you to open the !VizMapper and lock the !VizMapper. The __View → Desktop__ provide further control over the various !CytoPanels.  attachment:menu_edit_26.png
Line 38: Line 39:
attachment:menu_view.png === View ===
The View menu allows you to display or hide the network management panel (!CytoPanel 1), the attribute browser (!CytoPanel 2), the Network Overview (in !CytoPanel 1), and the !VizMapper.
Line 40: Line 42:
'''Select''' The __Select__ menu contains different options selecting nodes and edges. It also contains the __Select → Use Filters__ option which allows filters to be created which can be used to automatically select portions of a network whose node or edge attributes meet a filtering criterion.  attachment:menu_view_26.png
Line 42: Line 44:
attachment:menu_select.png === Select ===
The Select menu contains different options for selecting nodes and edges. It also contains the Select → Use Filters option, which allows filters to be created for automatic selection of portions of a network whose node or edge attributes meet a filtering criterion.
Line 44: Line 47:
'''Layout''' The __Layout__ menu has an array of features for organizing the network visually. The top of the menu contains tools for manipulating sections of networks. These tools include scale, rotate, distribute, and align. The bottom section of the menu lists a variety of layout algorithms which automatically lay a network out.  attachment:menu_select_26.png
Line 46: Line 49:
attachment:menu_layout.png === Layout ===
The Layout menu has an array of features for visually organizing the network. The features in the top portion of the network (Rotate, Scale, Align and Distribute) are tools for manipulating the network visualization. The bottom section of the menu lists a variety of layout algorithms which automatically lay a network out.
Line 48: Line 52:
'''Plugins''' The __Plugins__ menu has menu items or choices added by plugins that have been loaded, such as "Import BioPAX Document from file". Depending on which plugins are loaded, the plugins that you see may be different than what appear here.  attachment:menu_layout_25.png
Line 50: Line 54:
attachment:menu_plugins.png
||Note: A list of available Cytoscape Plugins with descriptions is available online at: http://cytoscape.org/plugins2.php ||
=== Plugins ===
The Plugins menu contains options for managing (install/update/delete) your plugins and may have options added by plugins that have been installed, such as the Agilent Literature Search or Merge Networks. Depending on which plugins are loaded, the plugins that you see may be different than what appear here.

 attachment:menu_plugins_25.png

||Note: A list of available Cytoscape plugins with descriptions is available online at: http://cytoscape.org/plugins2.php||
Line 54: Line 62:
'''Help''' The __Help__ menu allows you to launch the online help viewer and browse the table of contents (Contents…). The “About…” menu item displays information about the running version of Cytoscape. === Help ===
The Help menu allows you to launch the online help viewer and browse the table of contents for this manual. The “About…” option displays information about the running version of Cytoscape.
Line 56: Line 65:
attachment:menu_help.png  attachment:menu_help_25.png
Line 59: Line 68:
Cytoscape 2.3 allows multiple networks to be loaded at a time, either with or without a view. A network stores all the nodes and edges that are loaded by the user and a view displays them. You can have many views of the same network. Networks (and their optionally associated views) can be organized hierarchically. Cytoscape 2.3 and newer versions allow multiple networks to be loaded at a time, either with or without a view. A network stores all the nodes and edges that are loaded by the user and a view displays them. You can have many views of the same network. Networks (and their optionally associated views) can be organized hierarchically.
Line 63: Line 72:
attachment:cytoscape_network_hierarchy.png attachment:cytoscape_network_hierarchy_25.png
Line 67: Line 76:
Some networks are very large (thousands of nodes and edges) and can take a long time to display. For this reason, a network in Cytoscape may not contain a ‘view’. Networks that have a view are highlighted in green and networks that don’t have a view are highlighted in red. You can create or destroy a view for a network by right-clicking the network name in the network manager or by choosing the appropriate option in the edit menu. You can also destroy previously loaded networks this way. In the picture above, seven networks are loaded, six green ones with views and one red one without a view. Some networks are very large (thousands of nodes and edges) and can take a long time to display. For this reason, a network in Cytoscape may not contain a ‘view’. Networks that have a view are highlighted in green and networks that don’t have a view are highlighted in red. You can create or destroy a view for a network by right-clicking the network name in the network manager or by choosing the appropriate option in the Edit menu. You can also destroy previously loaded networks this way. In the picture above, seven networks are loaded, six green ones with views and one red one without a view.
Line 69: Line 78:
Certain operations in Cytoscape will create new networks. If a new network is created from an old network, for example by selecting a set of nodes in one network and copying these nodes to a new network (via the __File New Network__ option), it will be shown as a child of the network that it was derived from. In this way, the relationships between networks that are loaded in Cytoscape can be seen at a glance. Networks in the top part of the tree in the figure above were generated in this manner. Certain operations in Cytoscape will create new networks. If a new network is created from an old network, for example by selecting a set of nodes in one network and copying these nodes to a new network (via the File → New → Network option), it will be shown as a child of the network that it was derived from. In this way, the relationships between networks that are loaded in Cytoscape can be seen at a glance. Networks in the top part of the tree in the figure above were generated in this manner.
Line 71: Line 80:
The available network views are also arranged as multiple, overlapping windows in the network view window. You can maximize, minimize, and destroy network views by using the normal window controls for your operating system. The available network views are also arranged as multiple overlapping windows in the network view window. You can maximize, minimize, and destroy network views by using the normal window controls for your operating system.
Line 74: Line 83:
The network overview window shows an overview (or ‘bird’s eye view’) of the network. It can be used to navigate around a large network view. This feature can be turned on or off via the __View → Show/Hide Network Overview__ menu. The blue rectangle in the overview window shown below can be dragged with the mouse to navigate to a part of the network. The size of the navigation rectangle depends on the size of the active view and the zoom level of the view. The rectangle is smaller if the view is zoomed in and larger if zoomed out. The network overview window shows an overview (or ‘bird’s eye view’) of the network. It can be used to navigate around a large network view. The blue rectangle indicates the portion of the network currently displayed in the network view window, and it can be dragged with the mouse to view other portions of the network. Zooming in will cause the rectangle to appear smaller and vice versa.
Line 76: Line 85:
attachment:network_overview.png  attachment:network_overview_25.png

When a network is loaded, Cytoscape will look something like the image below:

attachment:cytoscape_startup_network_26.png

The main window here has several components:

  • The menu bar at the top (see below for more information about each menu).
  • The toolbar, which contains icons for commonly used functions. These functions are also available via the menus. Hover the mouse pointer over an icon and wait momentarily for a description to appear as a tooltip.
  • The network management panel (top left panel). This contains an optional network overview pane (shown at the bottom left).
  • The main network view window, which displays the network.
  • The attribute browser panel (bottom panel), which displays attributes of selected nodes and edges and enables you to modify the values of attributes.

The network management and attribute browser panels are dockable tabbed panels known as CytoPanels. You can undock any of these panels by clicking on the Float Window control attachment:float_icon.png in the upper-right corner of the CytoPanel.

If you select this control, e.g. on the attribute browser panel, you will now have two Cytoscape windows, the main window, and a new window labeled CytoPanel 2, similar to the one shown below. Popup will be displayed when you put the mouse pointer on a cell.

  • attachment:attribute_browser_26.png

Note that CytoPanel 2 now has a Dock Window control. If you select this control, the window will dock onto the main window.

Cytoscape also has an editor that enables you to build and modify networks interactively by dragging and dropping nodes and edges from a palette onto the main network view window. The Node shapes and Edge arrows on the palette are defined by the currently used Visual Style. To edit a network, just select the Editor tab on CytoPanel 1. An example of an editor, with the palette contained in CytoPanel 1 and defined by the BioMoleculeEditor Visual Style, is shown below.

  • attachment:editor_25.png

Anchor(menus)

The Menus

File

The File menu contains most basic file functionality: File → Open for opening a Cytoscape session file; File → New for creating a new network, either blank for editing, or from an existing network; File → Save for saving a session file; File → Import for importing data such as networks and attributes; and File → Export for exporting data and images. Also, File → Print allows printing, while File → Quit closes all windows of Cytoscape and exits the program.

  • attachment:menu_file_26.png

Edit

The Edit menu contains Undo and Redo functions which undo and redo edits made in the Attribute Browser, the Network Editor and to layout.

There are also options for creating and destroying views (graphical representations of a network) and networks (the raw network data – not yet visualized), as well as an option for deleting selected nodes and edges from the current network. All deleted nodes and edges can be restored to the network via Edit → Undo. Editing preferences for properties and plugins is found under Edit → Preferences → Properties... .

  • attachment:menu_edit_26.png

View

The View menu allows you to display or hide the network management panel (CytoPanel 1), the attribute browser (CytoPanel 2), the Network Overview (in CytoPanel 1), and the VizMapper.

  • attachment:menu_view_26.png

Select

The Select menu contains different options for selecting nodes and edges. It also contains the Select → Use Filters option, which allows filters to be created for automatic selection of portions of a network whose node or edge attributes meet a filtering criterion.

  • attachment:menu_select_26.png

Layout

The Layout menu has an array of features for visually organizing the network. The features in the top portion of the network (Rotate, Scale, Align and Distribute) are tools for manipulating the network visualization. The bottom section of the menu lists a variety of layout algorithms which automatically lay a network out.

  • attachment:menu_layout_25.png

Plugins

The Plugins menu contains options for managing (install/update/delete) your plugins and may have options added by plugins that have been installed, such as the Agilent Literature Search or Merge Networks. Depending on which plugins are loaded, the plugins that you see may be different than what appear here.

  • attachment:menu_plugins_25.png

Note: A list of available Cytoscape plugins with descriptions is available online at: http://cytoscape.org/plugins2.php

Help

The Help menu allows you to launch the online help viewer and browse the table of contents for this manual. The “About…” option displays information about the running version of Cytoscape.

  • attachment:menu_help_25.png

Network Management

Cytoscape 2.3 and newer versions allow multiple networks to be loaded at a time, either with or without a view. A network stores all the nodes and edges that are loaded by the user and a view displays them. You can have many views of the same network. Networks (and their optionally associated views) can be organized hierarchically.

An example where a number of networks have been loaded and arranged hierarchically is shown below:

attachment:cytoscape_network_hierarchy_25.png

The network manager (top-right tree view in CytoPanel 1) shows the networks that are loaded. Clicking on a network here will make that view active in the main window, if the view exists (green highlighted networks only). Each network has a name and size (number of nodes and edges), which are shown in the network manager. If a network is loaded from a file, the network name is the name of the file.

Some networks are very large (thousands of nodes and edges) and can take a long time to display. For this reason, a network in Cytoscape may not contain a ‘view’. Networks that have a view are highlighted in green and networks that don’t have a view are highlighted in red. You can create or destroy a view for a network by right-clicking the network name in the network manager or by choosing the appropriate option in the Edit menu. You can also destroy previously loaded networks this way. In the picture above, seven networks are loaded, six green ones with views and one red one without a view.

Certain operations in Cytoscape will create new networks. If a new network is created from an old network, for example by selecting a set of nodes in one network and copying these nodes to a new network (via the File → New → Network option), it will be shown as a child of the network that it was derived from. In this way, the relationships between networks that are loaded in Cytoscape can be seen at a glance. Networks in the top part of the tree in the figure above were generated in this manner.

The available network views are also arranged as multiple overlapping windows in the network view window. You can maximize, minimize, and destroy network views by using the normal window controls for your operating system.

The Network Overview Window

The network overview window shows an overview (or ‘bird’s eye view’) of the network. It can be used to navigate around a large network view. The blue rectangle indicates the portion of the network currently displayed in the network view window, and it can be dragged with the mouse to view other portions of the network. Zooming in will cause the rectangle to appear smaller and vice versa.

  • attachment:network_overview_25.png

Cytoscape_User_Manual/Quick_Tour (last edited 2010-07-28 03:12:12 by KeiichiroOno)

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