py4cytoscape.tables.get_table_column_names

get_table_column_names(table='node', namespace='default', network=None, base_url='http://127.0.0.1:1234/v1')[source]

Retrieve the names of all columns in a table.

Parameters

  • table (str) – Name of table, e.g., node, edge, network; default is “node”

  • namespace (str) – Namespace of table. Default is “default”.

  • 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

list of column names

Return type

list

Raises

  • HTTPError – if table or namespace or table doesn’t exist in network

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

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

Examples

>>> get_table_column_names()
['SUID', 'shared name', 'name', 'selected', 'AverageShortestPathLength', ... ]
>>> get_table_column_names('edge')
['SUID', 'shared name', 'shared interaction', 'name', 'selected', 'interaction', 'EdgeBetweenness']
>>> get_table_column_names('network', network='My Network')
['SUID', 'shared name', 'name', 'selected', '__Annotations', 'publication', 'Dataset Name', 'Dataset URL']