ndex_get_network: Get complete network

View source: R/ndex_networks_simple_operations.r

ndex_get_networkR Documentation

Get complete network

Description

Returns the specified network as RCX-object.

Usage

ndex_get_network(ndexcon, networkId)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

networkId

unique ID of the network

Details

Note: In future 'ndexr' uses the RCX-object from the corresponding package to handle the networks!

This is performed as a monolithic operation, so it is typically advisable for applications to first use the getNetworkSummary method to check the node and edge counts for a network before retrieving the network. Uses getEdges (this procedure will return complete network with all elements) Nodes use primary ID of the base term ('represents' element) Edges use primary ID of the base term ('predicate', or 'p' element) Mapping table for the nodes is retrieved ('alias' and 'related' terms) to facilitate conversions/data mapping

Value

RCX-object object

REST query

GET: ndex_config$api$network$get

Note

Compatible to NDEx server version 1.3 and 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find a network and get its UUID
networks = ndex_find_networks(ndexcon,"p53", "nci-pid")
networkId = networks[1,"externalId"]
## Get the network data 
rcx = ndex_get_network(ndexcon, networkId) 

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