py4cytoscape.networks.export_network

export_network(filename=None, type='SIF', network=None, base_url='http://127.0.0.1:1234/v1', *, overwrite_file=False)[source]

Export a network to one of mulitple file formats.

Parameters

  • filename (str) – Full path or path relative to current working directory, in addition to the name of the file. Extension is automatically added based on the type argument. If blank, then the current network name is used.

  • type (str) – File type. SIF (default), CX, cyjs, graphML, NNF, xGMML.

  • network (SUID or str or None) – Name or SUID of a network or view. 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.

  • overwrite_file (bool) – False allows Cytoscape show a message box before overwriting the file if the file already exists; True allows Cytoscape to overwrite it without asking

Returns

server JSON response

Return type

dict

Raises

  • ValueError – if server response has no JSON

  • CyError – if file exists and user opts to not overwrite it

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

Examples

>>> export_network('/path/filename','SIF')
{ 'data': {'file': 'C:\Users\CyDeveloper\xx'}, 'errors': [] }
>>> export_network('/path/filename','SIF', overwrite_file=True) # overwrite file without first asking
{ 'data': {'file': 'C:\Users\CyDeveloper\xx'}, 'errors': [] }