ndex_find_user_byName: Get User By Name

View source: R/ndex_users.R

ndex_find_user_byNameR Documentation

Get User By Name

Description

Get User By Name

Usage

ndex_find_user_byName(ndexcon, name)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

name

name of the user

Value

list of properties describing the user (externalId, emailAddress, website, etc.). Throws error (404) if user isn't found!

REST query

GET: ndex_config$api$user$get$byName

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find user by name
user = ndex_find_user_byName(ndexcon, 'ndextutorials')

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