ndex_update_group: Update Group

In frankkramer-lab/ndexr: NDEx R client library

Update Group

Description

Updates the group based on the data.

Usage

ndex_update_group(
  ndexcon,
  groupId,
  groupName,
  image,
  website,
  description,
  properties
)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
groupId	character; unique ID (UUID) of the group
groupName	character; name of the new graoup
image	character (optional); URL of the account owner's image.
website	character (optional); URL of the account owner's web site
description	character (optional); Short description of this user.
properties	list (optional); additional properties for the group

Value

Empty string ("") on success, else error

REST query

PUT: ndex_config$api$user$update

Note

Requires an authorized user! (ndex_connect with credentials)

Compatible to NDEx server version 2.0

Examples

## 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"]
## Update the group
# ndex_update_group(ndexcon, groupId, description='A really nice group!')
NULL

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