CyNetworkRelations: Cytoscape network relations

In frankkramer-lab/RCX: R package implementing the Cytoscape Exchange (CX) format

Cytoscape network relations

Description

This function is used to create Cytoscape network relations aspects.

Usage

createCyNetworkRelations(child, parent = NULL, name = NULL, isView = FALSE)

Arguments

child	integer; reference to subnetwork id
parent	integer (optional); reference to subnetwork id, but left blank (or NA) for root-network
name	character (optional); name of the subnetwork or view
isView	logical (optional); TRUE for views, else the network defines a subnetwork

Details

Cytoscape contributes aspects that organize subnetworks, attribute tables, and visual attributes for use by its own layout and analysis tools. Furthermore are the aspects used in web-based visualizations like within the NDEx platform.

Cytoscape network relations define the relationship between the main network, subnetworks and views and also a name can be assigned to the relationship. Both, subnetworks and views are defined as subnetworks aspect, but their type is defined here by the isView property. The parent of a subnetwork or view can be an other subnetwork or the root network.

Value

CyNetworkRelationsAspect object

See Also

updateCyNetworkRelations;

Examples

## a minimal example
cyNetworkRelations = createCyNetworkRelations(
  child = 1
)

## with all parameters
cyNetworkRelations = createCyNetworkRelations(
  child = c(1,2),
  parent = c(NA,1),
  name = c("Network A",
           "View A"),
  isView = c(FALSE, TRUE)
)

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