py4cytoscape.groups.delete_group¶
-
delete_group
(groups=None, groups_by_col='SUID', network=None, base_url='http://127.0.0.1:1234/v1')[source]¶ Delete one or more groups, while leaving member nodes intact.
- Parameters
groups (list or str or None) – all, selected, unselected. Default is the currently selected group.
groups_by_col (str) – name of node table column corresponding to provided groups list. Default is ‘SUID’.
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’: [group SUIDs]} with the SUID for each deleted group in the 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
>>> delete_group(['Group 1', 'Group 2'], groups_by_col='shared name') # delete groups by name {'groups':[7970, 7980]} >>> delete_group('Group 1,Group 2', groups_by_col='shared name') # delete groups by name {'groups':[7970, 7980]} >>> delete_group([7970]) # delete groups by SUID {'groups':[7970]} >>> delete_group(7970) # delete groups by SUID {'groups':[7970]} >>> delete_group() # delete all selected groups {'groups':[7970, 7980]} >>> delete_group(groups='all') # delete all groups {'groups':[7970, 7980]}
Note
Group nodes are ungrouped but not deleted in Cytoscape 3.6.1