Differences between revisions 39 and 49 (spanning 10 versions)
Revision 39 as of 2013-12-11 22:15:50
Size: 14604
Comment:
Revision 49 as of 2014-01-29 19:06:56
Size: 15680
Comment:
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
Network files can be specified in any of the formats described in the [[Cytoscape_User_Manual/Network_Formats|Supported Network Formats]] chapter. Network files can be specified in any of the formats described in the '''[[Cytoscape_User_Manual/Network_Formats|Supported Network Formats]]''' section.
Line 26: Line 26:
Another issue for network import is the presence of firewalls, which can affect which files are accessible to a computer. To work around this problem, Cytoscape supports the use of proxy servers. To configure a proxy server, go to '''Edit → Preferences→ Proxy Settings...'''. This is further described in the [[Cytoscape_User_Manual/Preferences|Preferences]] chapter. Another issue for network import is the presence of firewalls, which can affect which files are accessible to a computer. To work around this problem, Cytoscape supports the use of proxy servers. To configure a proxy server, go to '''Edit → Preferences→ Proxy Settings...'''. This is further described in the '''[[Cytoscape_User_Manual/Preferences|Preferences]]''' section.
Line 67: Line 67:
The network import function cannot import node table columns - only edge table columns. To import node table columns from this table, please see the [[Cytoscape_User_Manual/TableColumnData|Table Column Data]] section of this manual. The network import function cannot import node table columns - only edge table columns. To import node table columns from this table, please see the [[Cytoscape_3/UserManual/Columns|Node and Edge Column Data]] section of this manual.
Line 134: Line 134:
 * [[http://code.google.com/p/psicquic/|PSICQUIC]]: Standard web service for biological interaction data sets. The following data providers support PSICQUIC:
  * APID
  * Bar
  * BIND
  * BindingDB
  * GeneMANIA
  * I2Z-IMEX
  * ChEMBL
  * BioGrid
  * InnateDB
  * InnateDB-IMEx
  * Interoporc
  * MB-Info
  * Molcon
  * Spike
  * TopFind
  * uniProt
  * VirHostNet
  * DIP
  * IntAct
  * MatrixDB
  * MPIDB
  * Reactome
  * Reactome-FIs
  * MINT
  * iRefIndex
  * STRING
 * [[http://code.google.com/p/psicquic/|PSICQUIC]]: Standard web service for biological interaction data sets. The full list of PSICQUIC-compatible databases is available [[http://www.ebi.ac.uk/Tools/webservices/psicquic/registry/registry?action=STATUS|here]].
Line 172: Line 145:
=== Example #1: Retrieving Protein-Protein Interaction Networks from Multiple Databases === === Example: Retrieving Protein-Protein Interaction Networks from Multiple Databases ===
Line 202: Line 175:
== Adding a Node == === Adding a Node ===
Line 208: Line 181:
== Adding an Edge ==

For adding an edge to connect to nodes, right-click on the source node. Select '''Edit → Add Edge''' from the pop-up menu. Next, click on the target node. Images below show the two steps for drawing an edge between two nodes. You can abort the drawing of the edge by pressing Esc key.

{{attachment:Figure2_Editor_Cy3.png}}

{{attachment:Figure3_Editor_Cy3.png}}

{{attachment:Figure4_Editor_Cy3.png}}

You can delete nodes and edges by selecting a number of nodes and edges, then selecting '''Edit → Delete Selected Nodes and Edges'''. You can recover any nodes and edges deleted from a network by going to '''Edit → Undo'''.
=== Adding an Edge ===

To add an edge to connect nodes, right-click on the source node. Select '''Edit → Add Edge''' from the pop-up menu. Next, click on the target node. Images below show the two steps for drawing an edge between two nodes. You can abort the drawing of the edge by pressing Esc key.
You can also select two or more nodes to connect and in the right-click menu select '''Add → Edges Connecting Selected Nodes''' to create edges connecting all selected nodes.

{{attachment:AddNodeMenu.png}}

{{attachment:AddEdgeMenu.png}}

You can delete nodes and edges by selecting a number of nodes and edges, then selecting '''Edit → Cut'''. You can recover any nodes and edges deleted from a network by going to '''Edit → Undo'''.

=== Grouping nodes ===

Any number of nodes can be grouped together and displayed as either one group node or as the individual nodes. To create a group, select two or more nodes and right-click to select '''Group → Group Selected Nodes'''. You will be prompted to select a name for the group node. Once a group is created, you can use the right-click menu to collapse or expand the group. You can also quickly collapse/expand a group by double-clicking on the group node or any of its children to toggle back and forth.

'''Collapsed group'''
 {{attachment:GroupCollapsed.png|400px|Collapsed group}}

'''Expanded group'''
 {{attachment:GroupExpanded.png|400px|Expanded group}}

=== Adding Network Annotations ===

Annotations in the form of text, images or shapes can be added to the network canvas by right-clicking anywhere on the canvas and selecting one of the Annotation choices in the '''Add''' menu. You can add an image of your own, choose from a shapes library or add either plain or bounded text. Shapes and text are customizable and any added annotations can be edited from the right-click context menu.

 {{attachment:AddNetworkAnnotations.png|Add Network Annotations}}
 

There are 4 different ways of creating networks in Cytoscape:

  1. Importing pre-existing, fixed-format network files.
  2. Importing pre-existing, unformatted text or Excel files.
  3. Importing data from from public databases.
  4. Creating an empty network and manually adding nodes and edges.

Import Fixed-Format Network Files

Network files can be specified in any of the formats described in the Supported Network Formats section. Networks are imported into Cytoscape through the File → Import → Network menu. The network file can either be located directly on the local computer, or found on a remote computer (in which case it will be referenced with a URL).

Load Networks from Local Computer

In order to load a network from a local file you can select File → Import → Network → File... or click on Cy3_icon_net_file_import.png on the tool bar. Choose the correct file in the file chooser dialog and press Open. Some sample network files of different types have been included in the sampleData folder in Cytoscape.

After you choose a network file, another dialog will pop up. Here, you can choose either to create a new network collection for the new network, or load the new network into an existing network collection. When you choose the latter, make sure to choose the right mapping column to map the new network to the existing network collection.

[ATTACH]

Network files in SIF, GML, and XGMML formats may also be loaded directly from the command line using the –N option.

Load Networks from a Remote Computer (URL import)

To load a network from a remote file, you can select File → Import → Network → URL... or click on Cy3_icon_net_url_import.png on the tool bar. In the import network dialog, insert the appropriate URL, either manually or using URL bookmarks. Bookmarked URLs can be accessed by clicking on the arrow to the right of the text field (see the Bookmark Manager in Preferences for more details on bookmarks). Also, you can drag and drop links from a web browser to the URL text box. Once a URL has been specified, click on the OK button to load the network.

Cy3_network_import_url_dialog.png

Another issue for network import is the presence of firewalls, which can affect which files are accessible to a computer. To work around this problem, Cytoscape supports the use of proxy servers. To configure a proxy server, go to Edit → Preferences→ Proxy Settings.... This is further described in the Preferences section.

Import Networks from Unformatted Table Files

Cytoscape supports the import of networks from delimited text files and Excel workbooks using File → Import → Network → File.... An interactive GUI allows users to specify parsing options for specified files. The screen provides a preview that shows how the file will be parsed given the current configuration. As the configuration changes, the preview updates automatically. In addition to specifying how the file will be parsed, the user must also choose the columns that represent the source and target nodes as well as an optional edge interaction type.

Cy3_network_table_import.png

Supported Files

The Import Network from Table function supports delimited text files and single-sheet Microsoft Excel Workbooks. The following is a sample table file:

source  target  interaction  boolean data       string data     floating point data
YJR022W YNR053C pp      TRUE    abcd12371       1.2344543
YER116C YDL013W pp      TRUE    abcd12372       1.2344543
YNL307C YAL038W pp      FALSE   abcd12373       1.2344543
YNL216W YCR012W pd      TRUE    abcd12374       1.2344543
YNL216W YGR254W pd      TRUE    abcd12375       1.2344543

The network table files should contain at least two columns for creating network with edges. If the file has only one column, the created network will not contain any edges. The interaction type is optional in this format. Therefore, a minimal network table looks like the following:

YJR022W YNR053C
YER116C YDL013W
YNL307C YAL038W
YNL216W YCR012W
YNL216W YGR254W

One row in a network table file represents an edge and its edge data columns. This means that a network file is considered a combination of network data and edge column data. A table may contain columns that aren't meant to be edge data. In this case, you can choose not to import those columns by clicking on the column header in the preview window. This function is useful when importing a data table like the following (1):

sampleTableData1.png

This data file is a tab-delimited text file and contains network data (interactions), edge data, and node data. To import network and edge data from this table, choose Unique ID A as source, Unique ID B as target, and Interactor types as interaction type. Next, turn off columns used for node data (Alternative ID A, species B, etc.). Other columns can be imported as edge data.

The network import function cannot import node table columns - only edge table columns. To import node table columns from this table, please see the Node and Edge Column Data section of this manual.

Note (1): This data is taken from the A merged human interactome datasets by Andrew Garrow, Yeyejide Adeleye and Guy Warner (Unilever, Safety and Environmental Assurance Center, 12 October 2006). Actual data files are available at http://www.cytoscape.org/cgi-bin/moin.cgi/Data_Sets/

Basic Operations

To import network from text/Excel tables, please follow these steps:

  1. Select File → Import → Network → File... or click on Cy3_icon_net_file_import.png on the tool bar.

  2. Select a table file in the file chooser dialog.
  3. Define the interaction parameters by specifying which columns of data contain the Source Interaction, Target Interaction, and Interaction Type. Setting the Interaction Type as Default Interaction will result in all interactions being given the value pp; this value can be modified in Advanced Options (below).

  4. (Optional) Define edge table columns, if applicable. Network table files can have edge table columns in addition to network data.
    • Enable/Disable Table Columns - By left-clicking on a column header in the preview table, you can enable/disable edge column data. If the header is checked and entries are blue, the column will be imported as an edge column data. For example, the table below shows that columns 1 through 3 will be used as network data, column 4 will not be imported, and columns 5 and 6 will be imported as edge table column data.

      • Cy3_network_table_sample.png

    • Change Column Name and Data Types - If you right-click on a column header in the preview table, you can modify the column name and data type. For more detail, see Modify Column Name/Type below.

  5. Click the Import button.

Import List of Nodes Without Edges

The table import feature supports lists of nodes without edges. If you select only a source column, it creates a network without interactions. This feature is useful with the node expansion function available from some web service clients. Please read the section Importing Networks from External Database for more detail.

Advanced Options

Cy3_network_import_advanced.png

You can select several options by checking the Show Text File Import Options checkbox.

  • Delimiter: You can select multiple delimiters for text tables. By default, Tab and Space are selected as delimiters.
  • Preview Options: When you select a network table file, the first 100 entries will be displayed in the preview panel. To display more entries, change the value for this option. If you want to show all entries in the file, select Show all entries in the file. You will need to click the Reload button to update the Preview panel.

  • Column Names
    • Transfer first line as column names: Selecting this option will cause all edge columns to be named according to the first data entry in that column.
    • Start Import Row: Set which row of the table to begin importing data from. For example, if you want to skip the first 3 rows in the file, set 4 for this option.
    • Comment Line: Rows starting with this character will not be imported. This option can be used to skip comment lines in text files.
  • Network Import Options: If the Interaction Type is set to Default Interaction, the value here will be used as the interaction type for all edges.

Modify Column Name/Type

In the Import Network from Table interface, you can change the name and data type of column by right-clicking on any column header:

Cy3_network_table_attr_dialog1.png

Column names and data types can be modified here.

  • Modify Column Name - just enter a new column name and click OK.
  • Modify Column Data Type - The following column data types are supported:
    • String
    • Boolean (True/False)
    • Integer
    • Floating Point
    • List of (one of) String/Boolean/Integer/Floating Point

Cytoscape has a basic data type detection function that automatically suggests the column data type according to its entries. This can be overridden by selecting the appropriate data type from the radio buttons provided. For lists, a global delimiter must be specified (i.e., all cells in the table must use the same delimiter).

Import Networks from Public Databases

Cytoscape has a feature called Import Network from Public Databases. Users can access various kinds of databases through this function, File → Import → Network → Public Databases....

Web Service Client Manager

Cytoscape has a feature called Web Service Client Manager. This is a framework to manage various kinds of web service clients in Cytoscape. By using web service clients, users can access remote data sources easily.

What is a Web Service?

A web service is a standardized, platform-independent mechanism for computers to interact over the internet. These days, many major biological databases publish their data with a web service API:

Cytoscape core developer team have developed several web service clients using this framework. Cytoscape supports many web services including:

  • PSICQUIC: Standard web service for biological interaction data sets. The full list of PSICQUIC-compatible databases is available here.

The following sections describe how to import network from external databases.

Getting Started

To get started, select File → Import → Network → Public Databases....

psi1.png

Example: Retrieving Protein-Protein Interaction Networks from Multiple Databases

  • Select File → Import → Network → Public Databases....

  • From the pull-down menu, select the Interaction databases Universal Client.

  • Enter one or more search terms, such as BRCA1.
  • Click the Search button to start the search.

  • Select databases from the hits. This selection will be saved as your default database list.
  • Click the Import button to import selected network data.

psi2.png

After confirming the download of interaction data, the network of BRCA1 will be imported and visualized.

psi3.png

Tip: Expanding the Network: Several of the Cytoscape web services provide additional options in the node context menu. To access these options, right-click on a node and select Apps → Extend Network by public interaction database.... For example, in the screenshot, we have loaded the BRCA1 network from IntAct, and have chosen to merge this node's neighbors into the existing network.

PSICQUIC Options

PSICQUIC Web Service Client has three search modes:

  • Search by ID
  • Search by MIQL
  • Search by Species

By default, search mode is set to Search by ID. You can search all databases by ID, such as gene symbol, Uniprot ID, or NCBI gene ID. If the search mode is set to MIQL, you can use MIQL for search. If you want to search interactions by keywords or specific functions, this is the powerful query language to filter the result. The last option is for importing all interactions for the species (i.e., interactome).

Create a New Network Manually

A new, empty network can also be created and nodes and edges manually added. To create an empty network, go to File → New → Network → Empty Network, and then manually add network components by right clicking on the network canvas or on a node.

Adding a Node

To add a new node, right-click on an empty space of the network view panel. Select Add → Node item from the pop-up menu. Image below shows the right click menu for creating a new node.

Figure1_Editor_Cy3.png

Adding an Edge

To add an edge to connect nodes, right-click on the source node. Select Edit → Add Edge from the pop-up menu. Next, click on the target node. Images below show the two steps for drawing an edge between two nodes. You can abort the drawing of the edge by pressing Esc key. You can also select two or more nodes to connect and in the right-click menu select Add → Edges Connecting Selected Nodes to create edges connecting all selected nodes.

AddNodeMenu.png

AddEdgeMenu.png

You can delete nodes and edges by selecting a number of nodes and edges, then selecting Edit → Cut. You can recover any nodes and edges deleted from a network by going to Edit → Undo.

Grouping nodes

Any number of nodes can be grouped together and displayed as either one group node or as the individual nodes. To create a group, select two or more nodes and right-click to select Group → Group Selected Nodes. You will be prompted to select a name for the group node. Once a group is created, you can use the right-click menu to collapse or expand the group. You can also quickly collapse/expand a group by double-clicking on the group node or any of its children to toggle back and forth.

Collapsed group

  • 400px

Expanded group

  • 400px

Adding Network Annotations

Annotations in the form of text, images or shapes can be added to the network canvas by right-clicking anywhere on the canvas and selecting one of the Annotation choices in the Add menu. You can add an image of your own, choose from a shapes library or add either plain or bounded text. Shapes and text are customizable and any added annotations can be edited from the right-click context menu.

  • Add Network Annotations

Cytoscape_3/UserManual/Creating_Networks (last edited 2016-04-26 22:14:34 by server2)

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