py4cytoscape.groups.collapse_group

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

Replace the representation of all of the nodes and edges in a group with a single node.

Parameters

  • groups (list or str) – List of group names or keywords: all, selected, unselected. Default is the currently selected group.

  • 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

{‘groups’: [List of SUIDs]} where SUID identifies the node corresponding to the group that was collapsed (even if it was already collapsed)

Return type

dict

Raises

  • CyError – if network name or SUID, or group name or SUID doesn’t exist

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

Examples

>>> collapse_group() # collapse all selected groups
{'groups': [95335, 95336]}
>>> collapse_group('all') # collapse all groups
{'groups': [95335, 95336, 95337]}
>>> collapse_group(['Group 1', 'Group 2']) # collapse 2 groups
{'groups': [95335, 95336]}
>>> collapse_group('Group 1,Group 2') # collapse 2 groups
{'groups': [95335, 95336]}
>>> collapse_group(['SUID:95335', 'SUID:95336']) # collapse 2 groups
{'groups': [95335, 95336]}
>>> collapse_group('SUID:95335,SUID:95336') # collapse 2 groups
{'groups': [95335, 95336]}