ndex_get_group: Get a Group

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_groups.R

Description

Get a Group

Usage

1
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

1
2
3
4
5
6
7
## 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)

ndexr documentation built on April 29, 2020, 5:20 a.m.