closeSession: Close Session

In RCy3: Functions to Access and Control Cytoscape

Description

Closes the current session in Cytoscape, destroying all unsaved work.

Usage

closeSession(save.before.closing, filename = NULL, base.url = .defaultBaseUrl)

Arguments

save.before.closing	boolean Whether to save before closing the current session. If FALSE, then all unsaved work will be lost.
filename	(optional) If save.before.closing is TRUE and the session has not previously been saved, then the path and name of the session file to save should be provided. Default is NULL.
base.url	(optional) 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 RCy3.

Details

A boolean for whether to save before closing is required since you could lose data by closing without saving.

Value

None

Examples

closeSession(FALSE)
closeSession(TRUE, '/fullpath/mySession')
closeSession(TRUE)

RCy3 documentation built on Nov. 21, 2020, 2 a.m.