ndex_create_group: Create Group

In frankkramer-lab/ndexr: NDEx R client library

Create Group

Description

Create a group owned by the authenticated user based on the supplied group JSON object.

Usage

ndex_create_group(ndexcon, groupName, image, website, description, properties)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
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

url (including the UUID) of the newly created group

REST query

POST: ndex_config$api$group$create

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')
# groupURL = ndex_create_group(ndexcon, 'SomeGroupName')
## [1] "http://public.ndexbio.org/v2/group/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
# groupURL = ndex_create_group(ndexcon, 'SomeGroupName', 
#                              image='http://bit.ly/1M3NoQZ', 
#                              website='www.gidf.com', 
#                              description='A very special group..')
NULL

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