ndex_get_group: Get a Group

In frankkramer-lab/ndexr: NDEx R client library

Get a Group

Description

Get a Group

Usage

ndex_get_group(ndexcon, groupId)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
groupId	character; unique ID (UUID) of the group

Value

list of properties describing the group (externalId, emailAddress, website, etc.). Throws error (404) if group isn't found!

REST query

GET: ndex_config$api$group$get

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"]
## Get group information
group = ndex_get_group(ndexcon, groupId)

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