createSubnetwork: Create subnetwork from existing network

Description Usage Arguments Details Value See Also Examples

View source: R/createSubnetwork.R

Description

Copies a subset of nodes and edges into a newly created subnetwork.

Usage

1
2
3
createSubnetwork(nodes, nodes.by.col = "name", edges, edges.by.col = "name",
  exclude.edges = "F", subnetwork.name, network = "current",
  base.url = "http://localhost:1234/v1")

Arguments

nodes

list of node names or keyword: selected, unselected or all

nodes.by.col

name of node table column corresponding to provided nodes list; default is 'name'

edges

list of edge names or keyword: selected, unselected or all

edges.by.col

name of edge table column corresponding to provided edges list; default is 'name'

exclude.edges

(boolean) whether to exclude connecting edges; default is FALSE

subnetwork.name

name of new subnetwork to be created; default is to add a numbered suffix to source network name

network

name or suid of the source network; default is "current" network

base.url

cyrest base url for communicating with cytoscape

Details

If you specify both nodes and edges, the resulting subset will be the union of those sets. Typical usage only requires specifying either nodes or edges. Note that selected nodes will bring along their connecting edges by default (see exclude.edges arg) and selected edges will always bring along their source and target nodes.

Value

SUID of new subnetwork

See Also

createNetwork

Examples

1
2
3
4
5
createSubnetwork("selected")
createSubnetwork("selected",subnetwork.name="mySubnetwork")
createSubnetwork(c("node 1","node 2","node 3"))
createSubnetwork(c("AKT1","TP53","PIK3CA"),"display name")
createSubnetwork(edges="all") #subnetwork of all connected nodes

cytoscape/r2cytoscape documentation built on May 4, 2019, 6:36 p.m.