py4cytoscape.network_selection.select_edges

select_edges(edges, by_col='SUID', preserve_current_selection=True, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Select edges in the network by SUID, name or other column values.

Parameters

  • edges (str or list or int or None) – List of edges as list of edge names or SUIDs, comma-separated string of edge names or SUIDs, or scalar edge name or SUID. Edge names should be found in the SUID column of the edge table unless specified in edges_by_col.

  • by_col (str) – Edge table column to lookup up provide edge values. Default is ‘SUID’.

  • preserve_current_selection (bool) – Whether to maintain previously selected edges.

  • 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(None)
{}
>>> select_edges([103332, 108034], preserve_current_selection=False, network='My Network')
{'nodes': [], 'edges': [108033, 108034]}
>>> select_edges(103332, preserve_current_selection=False, network='My Network')
{'nodes': [], 'edges': [108033]}
>>> select_edges('YGL035C (pd) YIL162W', by_col='name', preserve_current_selection=False, network='My Network')
{'nodes': [], 'edges': [108033]}
>>> select_edges(['YGL035C (pd) YIL162W', 'YGL035C (pd) YLR044C', 'YNL216W (pd) YLR044C'], by_col='name', preserve_current_selection=True, network=52)
{'nodes': [], 'edges': [108033, 108034, 108103]}
>>> select_edges('YGL035C (pd) YIL162W, YGL035C (pd) YLR044C, YNL216W (pd) YLR044C', by_col='name', preserve_current_selection=True, network=52)
{'nodes': [], 'edges': [108033, 108034, 108103]}

Note

In the return value, node list is always empty, and edge list is the SUIDs of newly selected edges – dict is {} if no edges were selected