py4cytoscape.network_selection.select_edges_adjacent_to_nodes¶
-
select_edges_adjacent_to_nodes
(nodes, by_col='name', keep_select_nodes=True, network=None, base_url='http://127.0.0.1:1234/v1')[source]¶ Take currently selected nodes and add to the selection all edges connected to those nodes, regardless of directionality.
Any nodes or edges selected beforehand are deselected before any new edges are selected
- Parameters
nodes (str or list or int or None) – List of nodes as
list
of node names or SUIDs, comma-separated string of node names or SUIDs, or scalar node name or SUID. Node names should be found in theSUID
column of thenode table
unless specified innodes_by_col
.by_col (str) – Node table column to lookup up provide node values. Default is ‘name’.
keep_select_nodes (bool) – True to return with nodes selected; False to return with no nodes selected
network (SUID or str or None) – Name or SUID of a network. Default is the “current” network active in Cytoscape.
base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.
- Returns
{‘nodes’: [node list], ‘edges’: [edge list]}
- Return type
dict
- Raises
CyError – if network name or SUID doesn’t exist
requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error
Examples
>>> select_edges_adjacent_to_nodes(None) {} >>> select_edges_adjacent_to_nodes(['RAP1'], by_col='COMMON') {'nodes': [107514], 'edges': []} >>> select_edges_adjacent_to_nodes('RAP1, HIS4', by_col='COMMON') {'nodes': [107514, 107511], 'edges': []} >>> select_edges_adjacent_to_nodes([107514, 107511], by_col='SUID') {'nodes': [107514, 107511], 'edges': []} >>> select_edges_adjacent_to_nodes(107514], keep_select_nodes=False) {'nodes': [107514], 'edges': []}
Note
To identify a node whose name contains a comma, use ‘\’ to escape the comma. For example, ‘node1, node\,2’ identifies ‘node1’ and ‘node,2’.
Note
In the return value, node list is list of all selected nodes, and edge list is the SUIDs of selected edges – dict is {} if no new nodes were selected