ndex_user_get_networksummary: Get User's Account Page Networks

In frankkramer-lab/ndexr: NDEx R client library

Get User's Account Page Networks

Description

This is a convenience function designed to support "My Account" pages in NDEx applications. It returns a list of NetworkSummary objects to display.

Usage

ndex_user_get_networksummary(ndexcon, userId)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
userId	character; unique ID (UUID) of the user

Value

data.frame of networks (name, description, externalId, uri, etc.) on the account page of the specified user

REST query

GET: ndex_config$api$user$networksummary

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')
## get user by name to get UUID
# user = ndex_find_user_byName(ndexcon, 'MyAccountName')
# userId = user$externalId
## get all network permissions of the user
# networkSummary = ndex_user_get_networksummary(con, user$externalId)
# names(networkSummary)
## [1] "ownerUUID"    "isReadOnly"  "subnetworkIds"  "errorMessage"      "isValid"         
## [6] "warnings"     "isShowcase"  "visibility"     "edgeCount"         "nodeCount"       
##[11] "uri"          "version"     "owner"          "name"              "properties"      
##[16] "description"  "externalId"  "isDeleted"      "modificationTime"  "creationTime"
NULL

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