CytoscapeWindow: CytoscapeWindow

Description Usage Arguments Value Author(s) See Also Examples

View source: R/RCy3.R

Description

The constructor for the CytoscapeWindowClass

Usage

1
2
3
CytoscapeWindow(title, graph = new("graphNEL", edgemode='directed'),
                 host = "localhost", port = 1234, 
                 create.window = TRUE, overwriteWindow=FALSE, collectTimings=FALSE)

Arguments

title

A character string, this is the name you will see on the Cytoscape network window. Multiple windows with the same name are not permitted.

graph

A Bioconductor graph.

host

Defaults to 'localhost', this is the domain name of a machine which is running Cytoscape with the appropriate CyREST plugin.

port

Defaults to 1234, this may be any port to which CyREST is listening.

create.window

Defaults to TRUE, but if you want a CytoscapeWindow just to call what in Java we would call 'class methods' – getWindowList (), for instance, a CytoscapeWindow without an actual window can be useful.

overwriteWindow

Every Cytoscape window must have a unique title. If the title that you supply is already in use, this method will fail unless you specify TRUE for this parameter, in which case the pre-existing window with the same title will be deleted before this new one is created.

collectTimings

Defaults to FALSE. Will record and report the time required to send a graph to Cytoscape.

Value

An object of the CytoscapeWindow Class.

Author(s)

Tanja Muetze, Georgi Kolishovski, Paul Shannon

See Also

CytoscapeWindow existing.CytoscapeWindow, predictTimeToDisplayGraph

Examples

1
2
3
4
5
6
7
  ## Not run: 
  # first, delete existing windows to save memory:
  deleteAllWindows(CytoscapeConnection())

  cw <- CytoscapeWindow ('new.demo', new ('graphNEL'))

## End(Not run)

RCy3 documentation built on Nov. 17, 2017, 1:22 p.m.