Diff for "Cytoscape_User_Manual/Filters"

Filters allow for a wide variety of filtering on node and edge attributes loaded onto Cytoscape networks. Filters are poorly named because what they really do is select nodes or edges based on properties you specifiy. For example, you can select all the nodes whose name contains a specific pattern. Several types of filters are available. Basic filters allow the selection of multiple nodes or edges according to attribute data:

• String filters allow selection of nodes or edges with attributes matching specified patterns. These patterns may include the wildcards * and ?.

• Numerical filters allow selection of nodes or edges according to numerical attributes and the mathematical operators >, =, and <.

• Topology filters allow selection of nodes with neighbors that match some pre-existing filter.

Compound filters allow selection based on the application of pre-existing filters:

• Boolean filters allow the combination of multiple filters using the AND, OR and XOR operators. Example filters are shipped with the plugin to get started.

Using Filters

By default, you should see a filter icon on the toolbar: attachment:filter_icon.png

If you press the filter icon, you will see a filters dialog which initially looks like the following:

attachment:init_filter_dialog.png

If the first filter is selected, then the dialog looks as shown:

attachment:first_filter_dialog.png

Filter Panels:

The right panel: An existing or newly created filter can be edited in this area. Each filter type has its own user interface for editing.

The low left panel: All available filters are shown in this list. Initially, this list will contain sample filters, but as you create more, they will be added here.

The up left panel: Pressing “Create new filter” adds a filter to the “Available Filters” box, and “Remove selected filter” deletes the currently selected filter.

Creating Filters

The “Create new filter” button brings up the Filter creation dialog box, shown below.

attachment:create_new_filter_dialog.png

The important thing to realize when creating a filter is that the filter does not do anything by itself. Once created, the filter must be run.

String Filter:

attachment:string_filter.png

The String Filter allows you to filter nodes or edges by a given string node or edge attribute. Attributes that are loaded on the network are available for filtering against. Search terms are entered in the text box at the bottom. For example to match any Node whose canonicalName starts with “YDL” you would select “Node”, “canonicalName” and type “YDL*”. The * is important as it matches any number of characters after YDL. If you want to be more specific and only select nodes whose canonicalName starts with YDL00 followed by any other two characters, you would type “YDL00??”. The “?” denotes any single character, while the “*” represents zero or more characters. Full regular expression searching is supported, although is not covered here. Once the filter is defined, it will be assigned a default descriptive name.

Numerical Filter:

attachment:numerical_filter.png

The Numerical Filter also allows you to filter nodes or edges, and presents you with a list of available attributes. This filter matches greater-than, less-than, or equal-to a number you type in the search box.

Node Topology Filter:

attachment:node_topology_filter.png

The node topology filter allows you to select nodes with at least n neighbors of distance m or less that pass some other selected filter. For instance, to select all the nodes adjacent to a node with the canonical name matching ‘YD*’, you would “select nodes with 1 neighbors”, “within distance 1”, “that pass the filter Node: canonicalName ~ YD*”.

The node topology filter depends on the existence of other filters. By default the [No Filter] is selected for this purpose. The [No Filter] doesn't filter anything, rather it selects all nodes.

Boolean Filter:

attachment:boolean_filter.png

The Boolean Meta-Filter allows you to define a new filter that is a logical combination of existing filters. Available filters are displayed. By selecting one or more filters, you can then choose whether Nodes or Edges pass “ALL” (AND), “AT LEAST ONE” (OR), or “ONLY ONE” (XOR) of the selected filters. Once created Boolean filters can then themselves be combined using the Boolean filter to create arbitrarily complex logical combinations of filters. Note that unlike the String and Numerical Filters, Boolean Filters will need to be assigned a name manually.

Saving Filters

Filters are currently saved automatically in the filters.props file found in the .cytoscape directory, found in each user's home directory. Once created, filters are saved for future sessions, as long as you exit Cytoscape normally via the exit command in the File menu (i.e. not via ctrl-c on Linux).

Running filters

Any available filter can be run by pressing the ‘Apply selected filter’ button. When a filter is applied and multiple nodes or edges are selected, all of the normal selection-related operations may be performed, such as Delete Selected Node/Edges, Copy To New Network, and Invert Selection.