ndex_network_get_aspect: Get a Network Aspect As CX

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_networks_aspects_and_metadata.r

Description

This function retrieves the provided aspect as CX. The result is the same as accessing an aspect of a RCX object.

Usage

1
ndex_network_get_aspect(ndexcon, networkId, aspect, size)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

networkId

character; unique ID of the network

aspect

character; name of the aspect

size

integer; specifies the number of elements returned

Value

data.frame of the aspect data (the same as rcx[[aspectName]])

REST query

GET: ndex_config$api$network$aspect$getMetaDataByName

Note

Compatible to NDEx server version 1.3 and 2.0, but doesn't work for version 1.3

Examples

1
2
3
4
5
6
7
8
9
## Establish a server connection
ndexcon = ndex_connect()
## Find a network and get its UUID
networks = ndex_find_networks(ndexcon)
networkId = networks[1,"externalId"]
## Get the aspect of a network
aspect = ndex_network_get_aspect(ndexcon, networkId, 'nodeAttributes')
# limit the returned elements of the aspect to the first 10 elements
aspect = ndex_network_get_aspect(ndexcon, networkId, 'nodeAttributes', 10)

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