py4cytoscape.groups.create_group_by_column

create_group_by_column(group_name, column=None, value=None, network=None, base_url='http://127.0.0.1:1234/v1')[source]

Create a group of nodes defined by a column value.

Parameters

  • group_name (str) – The name used to identify and optionaly label the new group

  • column (str) – The name or header of the Node Table column to use for selecting nodes to group

  • value (str or int or float or bool) – The value in the column to use for selecting nodes to 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

{‘group’: group SUID} where the SUID identifies new group

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

>>> create_group_by_column('Group 1', 'Cluster', 'A')
{'group': 95336}