rcx_updateMetaData {ndexr}R Documentation

Updating the meta-data of an RCX object

Description

Updating the meta-data of an RCX object

Usage

rcx_updateMetaData(rcx, mandatoryAspects = c("nodes"),
  excludeAspects = c("metaData", "numberVerification", "status"),
  force = FALSE, verbose = FALSE)

Arguments

rcx

RCX object

mandatoryAspects

character vector; Aspects, that are mandatory for a valid RCX object (by default: "nodes")

excludeAspects

character vector; Aspects, that are excluded for generating metaData (by default: "metaData", "numberVerification" and "status")

force

logical; force the creation of new metaData (even if the RCX object already contains metaData)

verbose

logical; whether to print out extended feedback

Details

For a given RCX object the meta-data is updated, i.e. the counted elements and id counter are updated. If an aspect was added/removed, it will also added/removed from the meta-data. If mandatory aspects (specified in mandatoryAspects parameter) are missing in the RCX object, an error is thrown.

Value

RCX object

Examples

## 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 network data 
rcx = ndex_get_network(ndexcon, networkId) 
## update meta-data
rcx = rcx_updateMetaData(rcx)
# or with explicitly set default values
rcx = rcx_updateMetaData(rcx, mandatoryAspects=c('nodes'), excludeAspects=c("metaData", "numberVerification", "status"), force=FALSE, verbose=FALSE)

[Package ndexr version 1.0.4 Index]