ndex_delete_group: Delete Group

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_groups.R

Description

Delete the group specified by groupId

Usage

1
ndex_delete_group(ndexcon, groupId)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

groupId

character; unique ID (UUID) of the group

Value

NULL if successfull, else an error is thrown

REST query

DELETE: ndex_config$api$group$delete

Note

Requires an authorized user! (ndex_connect with credentials)

Compatible to NDEx server version 2.0

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Establish a server connection with credentials 
# ndexcon = ndex_connect('MyAccountName', 'MyPassword')
## Find user and get its id
# user = ndex_find_user_byName(ndexcon, 'MyAccountName')
# userId = user$externalId
## Find the user's groups and get one group id
# groups = ndex_user_list_groups(ndexcon, userId)
# groupId = groups[1,"externalId"]
#ndex_delete_group(ndexcon,groupId)
NULL

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