py4cytoscape.collections.get_collection_name

get_collection_name(collection_suid=None, base_url='http://127.0.0.1:1234/v1')[source]

Get Collection Name.

Parameters

  • collection_suid (SUID or None) – SUID of a collection (or None for “current” collection)

  • base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

the name of the collection associated with SUID

Return type

str

Raises

  • CyError – if no collection exists

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

Examples

>>> get_collection_name()
'galFiltered.sif'
>>> get_collection_name(851296)
'galFiltered.sif'