py4cytoscape.network_selection.select_first_neighbors

select_first_neighbors(direction='any', network=None, base_url='http://127.0.0.1:1234/v1')[source]

Select nodes directly connected to currently selected nodes.

Can specify connection directionality using the direction param.

Parameters

  • direction (str) – direction of connections to neighbors to follow, e.g., incoming, outgoing, undirected, or any (default)

  • network (SUID or str or None) – Name or SUID of a network or view. 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_first_neighbors()
{'nodes': [107504, 107503, ...], 'edges': []}
>>> select_first_neighbors(direction='undirected')
{'nodes': [107514], 'edges': []}

Note

In the return value, node list is the SUIDs of newly selected nodes and edge list is always empty