ndex_network_update_profile: Update Network Profile

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_networks_ndex_properties.r

Description

Updates the profile information of the network. Any profile attributes specified will be updated but attributes that are not specified will have no effect - omission of an attribute does not mean deletion of that attribute.

Usage

1
2
ndex_network_update_profile(ndexcon, networkId, name = NULL,
  description = NULL, version = NULL)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

networkId

unique ID of the network

name

character (optional); Changes the name the network. At least one of name, description or version have to be set!

description

character (optional); Changes the description the network. At least one of name, description or version have to be set!

version

character (optional); Changes the version the network. At least one of name, description or version have to be set!

Value

NULL on success; Error else

REST query

GET: ndex_config$api$network$profile$update

Note

Requires an authorized user! (ndex_connect with credentials)

Compatible to NDEx server version 1.3 and 2.0

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Establish a server connection 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"]
## Update network profile
# ndex_network_update_profile(ndexcon, networkId, name="Some fancy name for the network")
# ndex_network_update_profile(ndexcon, networkId, description="Description of the network")
# ndex_network_update_profile(ndexcon, networkId, version="1.2.3.4")
# ndex_network_update_profile(ndexcon, networkId, name="Special test network", 
#                             description="Nothing to see here", version="1.3")
NULL

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