selectFirstNeighbors: Select first neighbor nodes

Description Usage Arguments Value Examples

View source: R/NetworkSelection.R

Description

Select nodes directly connected to currently selected nodes. Can specify connection directionality using the direction param.

Usage

1
2
3
4
5
selectFirstNeighbors(
  direction = "any",
  network = NULL,
  base.url = .defaultBaseUrl
)

Arguments

direction

direction of connections to neighbors to follow, e.g., incoming, outgoing, undirected, or any (default)

network

(optional) Name or SUID of the network. Default is the "current" network active in Cytoscape.

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.

Value

list of suids of selected nodes, including original selection

Examples

1
2
3
selectFirstNeighbors()
selectFirstNeighors('outgoing')
selectFirstNeighors('incoming')

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