rcx_updateMetaData: Updating the meta-data of an RCX object

In ndexr: NDEx R client library

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

## Create an RCX object
rcx = rcx_new(c('@id'=1, n='Some Name', r='HGNC:Symbol'))
## 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)

ndexr documentation built on March 13, 2021, 2 a.m.