ndex_update_network: Update an Entire Network as CX

In frankkramer-lab/ndexr: NDEx R client library

Update an Entire Network as CX

Description

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

Usage

ndex_update_network(ndexcon, rcx, networkId)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
rcx	RCX-object object
networkId	(optional); unique ID of the network

Details

This method updates/replaces a existing network on the NDEx server with new content from the given RCX object. The UUID can either be specified manually or it will be extracted from the RCX object (i.e. from rcx$ndexStatus$externalId).

Value

UUID of the updated network

REST query

PUT (multipart/form-data): ndex_config$api$network$update$url data: CXNetworkStream = data

Note

Requires an authorized user! (ndex_connect with credentials)

Compatible to NDEx server version 1.3 and 2.0

Examples

## Establish a server connections with credentials 
# ndexcon = ndex_connect('MyAccountName', 'MyPassword')
## Find one of your networks and get its UUID
# networks = ndex_find_networks(ndexcon, accountName='MyAccountName')
# networkId = networks[1,"externalId"]
## Get the network data 
# rcx = ndex_get_network(ndexcon, networkId) 
## Do some changes to rcx..
## and update the network
# networkId = ndex_update_network(ndexcon, rcx, networkId)
# networkId = ndex_update_network(ndexcon, rcx) ## same as previous
NULL

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