ndex_group_list_networks: Get Network Permissions of a Group

In frankkramer-lab/ndexr: NDEx R client library

Get Network Permissions of a Group

Description

Get Network Permissions of a Group

Usage

ndex_group_list_networks(
  ndexcon,
  groupId,
  permission = NULL,
  start = NULL,
  size = NULL
)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
groupId	character; unique ID (UUID) of the group
permission	character (optional) ("WRITE"|"READ) (default: "READ"); constrains the type of the returned permission.
start	integer (optional); specifies that the result is the nth page of the requested data.
size	integer (optional); specifies the number of data items in each page.

Value

List of network permissions of that group or empty object

REST query

GET: ndex_config$api$group$network$list

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find a group
groups = ndex_find_groups(ndexcon,"Ideker Lab")
groupId = groups[1,"externalId"]
## List networks of the group
networks = ndex_group_list_networks(ndexcon, groupId)
networks = ndex_group_list_networks(ndexcon, groupId, permission='READ', start=0, size=10)

frankkramer-lab/ndexr documentation built on April 4, 2023, 7:19 p.m.