updateMetaDataProperties: Update meta-data properties

View source: R/RCX-MetaData.R

updateMetaDataPropertiesR Documentation

Update meta-data properties

Description

The Meta-data aspect contains meta-data about the aspects in the RCX-object. Properties that need to be fetched or updated independently of aspect data are added with this function.

Usage

updateMetaDataProperties(rcx, aspectName, property)

Arguments

rcx

RCX object;

aspectName

character; name of the aspect as displayed in Meta-data (e.g. "nodes")

property

named list; property as key-value pairs (empty list to remove all)

Value

RCX object with updated Meta-data aspect

Examples

## prepare RCX object:
nodes = createNodes(name = c("a","b","c","d","e","f"))
edges = createEdges(source=c(1,2,0,0,0,2), 
                    target=c(2,3,1,2,5,4))
rcx = createRCX(nodes, edges)
cySubNetworks = createCySubNetworks(
  id = c(1,2),
  nodes = list("all", c(1,2,3)),
  edges = list("all", c(0,2))                    
)
rcx = updateCySubNetworks(rcx, cySubNetworks)

## add properties for edges
updateMetaDataProperties(rcx, 
                         "edges", 
                         list(some="value",
                              another="VALUE"))

## remove properties for edges
updateMetaDataProperties(rcx, 
                         "edges", 
                         list())

frankkramer-lab/RCX documentation built on Feb. 4, 2023, 5:12 p.m.