cyclient

cyclient(host="localhost", port=1234, version="V1")

A CyREST client.

• host CyREST host server address. default='localhost'
• port CyREST port number. default=1234

• version CyREST version. default='v1'

• returns status a cyclient object.

>>> from py2cytoscape import cyrest
>>> cytoscape=cyrest.cyclient()

---

cyclient.status

cyclient.status()

Checks the status of your CyREST server.

>>> from py2cytoscape import cyrest
>>> cytoscape=cyrest.cyclient()
>>> cytoscape.status()

CyREST online!

---

cyclient.version

cyclient.version()

Checks Cytoscape version.

>>> from py2cytoscape import cyrest
>>> cytoscape=cyrest.cyclient()
>>> cytoscape.version()

cytoscapeVersion 3.6.0
apiVersion v1

---

cyclient.copy

cyclient.copy()

Creates a copy of the cyclient object.

>>> from py2cytoscape import cyrest
>>> cytoscape=cyrest.cyclient()
>>> new=cytoscape.copy()

---

cyclient.result

cyclient.result(filetype="PNG", saveas=None, host=None, port=None)

Checks the current network.

• filetype file type eg.PDF, PNG, CYS, CYJS; default="PNG"
• saveas /path/to/non/tmp/file.prefix
• host cytoscape host address, default=cytoscape_host
• port cytoscape port, default=1234
• returns an image

>>> from py2cytoscape import cyrest
>>> cytoscape=cyrest.cyclient()
>>> cytoscape.result()

---