py4cytoscape.layouts.bundle_edges

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

Apply edge bundling to the network specified.

Edge bundling is executed with default parameters; optional parameters are not supported.

Parameters

  • network (SUID or str or None) – Name or SUID of the network; default is “current” network.

  • base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

{‘message’: ‘Edge bundling success.’}

Return type

dict

Raises

  • CyError – if layout_name is invalid

  • requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> bundle_edges() # Bundle edges in current network
{'message': 'Edge bundling success.'}
>>> bundle_edges('yeastHighQuality.sif') # Bundle edges in named network
{'message': 'Edge bundling success.'}