CyTableColumn: Cytoscape table column properties

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

Cytoscape table column properties

Description

This function is used to create Cytoscape table column aspects.

Usage

createCyTableColumn(
  appliesTo,
  name,
  dataType = NULL,
  isList = NULL,
  subnetworkId = NULL
)

Arguments

appliesTo	character; indicates whether this applies to "nodes", "edges" or "networks" table columns
name	character; key of the attribute
dataType	character (optional); data type of the attribute
isList	logical (optional); a value should be considered as list
subnetworkId	integer (optional); reference to subnetwork id, but left blank (or NA) if root-network

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.

These elements are used to represent Cytoscape table column labels and types. Its main use is to disambiguate empty table columns. The same attribute can also be defined for different subnetworks with different values. Cytoscape does not currently support table columns for the root network, but this is option is included here for consistency.

With isList it can be set, if a value should be considered as a list. This is of minor significance while working solely with RCX objects, unless it will be transformed to JSON.

Value

CyTableColumnAspect object

See Also

updateCyTableColumn; CyNetworkRelations

Examples

## a minimal example
tableColumn = createCyTableColumn(
  appliesTo="nodes",
  name="weight"
)

## defining several properties at once
tableColumn = createCyTableColumn(
  appliesTo=c("nodes","edges"),
  name=c("weight","weight")
)

## with all parameters
tableColumn = createCyTableColumn(
  appliesTo=c("nodes","edges","networks"),
  name=c("weight","weight","collapsed"),
  dataType=c("numeric","numeric","logical"),
  isList=c(FALSE,FALSE,TRUE),
  subnetworkId=c(NA,NA,1)
)

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