createGroupByColumn: Create Group by Column

Description Usage Arguments Value Examples

View source: R/Groups.R

Description

Create a group of nodes defined by a column value.

Usage

1
2
3
4
5
6
7
createGroupByColumn(
  group.name,
  column = NULL,
  value = NULL,
  network = NULL,
  base.url = .defaultBaseUrl
)

Arguments

group.name

The name used to identify and optionaly label the group

column

The name or header of the Node Table column to use for selecting nodes to group

value

The value in the column to use for selecting nodes to group

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

Group SUID

Examples

1
createGroupByColumn('myGroup','Cluster', 'A')

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