ndex_update_user: Update User

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_users.R

Description

Updates the authenticated user based on the data. Errors, if the user for ndexcon and uuid are different.

Usage

1
2
ndex_update_user(ndexcon, userId, emailAddress, isIndividual, displayName,
  firstName, lastName, image, website, description, verbose = FALSE)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

userId

character; unique ID of the user

emailAddress

character (optional); email address (used for verification if enabled)

isIndividual

boolean (default:True); True if this account is for an individual user. False means this account is for an organization or a project etc.

displayName

character (optional); Display name of this account, only applied to non-individual accounts.

firstName

character (optional); Account owner's first name, only applies to individual accounts.

lastName

character (optional); Account owner's last name, only appliies to individual accounts.

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.

verbose

logical (optional); whether to print out extended feedback

Value

Empty string ("") on success, else error

REST query

GET: ndex_config$api$user$update

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
11
## Establish a server connection with credentials 
# ndexcon = ndex_connect('MyAccountName', 'MyPassword')
## Find user and get its id
# user = ndex_find_user_byName(ndexcon, 'SomeUserName')
# userId = user$externalId
## Update user
# ndex_update_user(ndexcon, userId, firstName = 'Homer Jay', lastName = 'Simpson')
# ndex_update_user(ndexcon, userId, displayName = 'Max Power', 
#                  image='https://upload.wikimedia.org/wikipedia/en/0/02/Homer_Simpson_2006.png', 
#                  description='One of the most influential characters in the history of TV')
NULL

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