py4cytoscape.groups.add_to_group

add_to_group(group_name, nodes=None, nodes_by_col='SUID', edges=None, edges_by_col='SUID', network=None, base_url='http://127.0.0.1:1234/v1')[source]

Add the specified nodes and edges to the specified group.

Parameters

  • group_name (str) – Specifies the name used to identify the group

  • nodes (list or str or None) – List of node SUIDs, names, other column values, or keyword: selected, unselected or all. Default is currently selected nodes.

  • nodes_by_col (str) – name of node table column corresponding to provided nodes list. Default is ‘SUID’.

  • edges (list or str or None) – List of edge SUIDs, names, other column values, or keyword: selected, unselected or all. Default is currently selected edges.

  • edges_by_col (str) – name of edge table column corresponding to provided edges 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

{}

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

>>> add_to_group('Group 1', ['GDS1', 'SIP4', 'PDC1'], nodes_by_col='COMMON') # add nodes by common name & all selected edges
{}
>>> add_to_group('Group 1') # add all selected nodes and edges
{}
>>> add_to_group('Group 1', ['GDS1', 'SIP4', 'PDC1'], nodes_by_col='COMMON', edges=[]) # add all selected nodes and no edges
{}
>>> add_to_group('Group 1', nodes='unselected', edges='unselected') # add all unselected nodes and edges
{}