ndex_user_get_showcase: Get User's Showcase Networks

In frankkramer-lab/ndexr: NDEx R client library

Get User's Showcase Networks

Description

This is a convenience function to support "user pages" in NDEx applications. This function returns a list of network summary objects that the user who is specified by userid chose to display in his or her home page. For authenticated users, this function returns the networks that the authenticated user can read, for anonymous users, this function returns only public networks.

Usage

ndex_user_get_showcase(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.) in the showcase of the specified user

REST query

GET: ndex_config$api$user$showcase

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## get user by name to get UUID
user = ndex_find_user_byName(ndexcon, 'ndextutorials')
userId = user$externalId
## get all network permissions of the user
showcase = ndex_user_get_showcase(ndexcon, userId)
names(showcase)
## [1] "ownerUUID"    "isReadOnly"  "subnetworkIds"  "errorMessage"      "isValid"         
## [6] "warnings"     "isShowcase"  "visibility"     "edgeCount"         "nodeCount"       
##[11] "uri"          "version"     "owner"          "name"              "properties"      
##[16] "description"  "externalId"  "isDeleted"      "modificationTime"  "creationTime"

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