refersTo: Name of the property of an aspect that is an ID

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

Name of the property of an aspect that is an ID

Description

This function returns the name of the property and the aspect class it refers to. As example, the aspect EdgesAspect has the property source that refers to the ids of the NodesAspect aspect.

Usage

refersTo(aspect)

## Default S3 method:
refersTo(aspect)

## S3 method for class 'EdgesAspect'
refersTo(aspect)

## S3 method for class 'NodeAttributesAspect'
refersTo(aspect)

## S3 method for class 'EdgeAttributesAspect'
refersTo(aspect)

## S3 method for class 'CartesianLayoutAspect'
refersTo(aspect)

## S3 method for class 'CyGroupsAspect'
refersTo(aspect)

## S3 method for class 'CyVisualPropertiesAspect'
refersTo(aspect)

## S3 method for class 'CySubNetworksAspect'
refersTo(aspect)

Arguments

aspect

an object of one of the aspect classes (e.g. NodesAspect, EdgesAspect, etc.)

Details

Uses method dispatch, so the default return is NULL and only aspect classes that refer to other aspects are implemented. This way it is easier to extend the data model.

Value

named list; Name of the refering property and aspect class name.

Methods (by class)

• default: of default returns NULL

• EdgesAspect: of EdgesAspect refers to id by source and target

• NodeAttributesAspect: of NodeAttributesAspect refers to id by propertyOf and to id by subnetworkId

• EdgeAttributesAspect: of EdgeAttributesAspect refers to id by propertyOf and to id by subnetworkId

• CartesianLayoutAspect: of CartesianLayoutAspect refers to id by node and to id by view

• CyGroupsAspect: of CyGroupsAspect refers to id by nodes and to id by externalEdges and internalEdges

• CyVisualPropertiesAspect: of CyVisualPropertiesAspect refers to id by appliesTo of the sub-aspects

• CySubNetworksAspect: of refers to id by nodes and to id by edges

See Also

hasIds(), idProperty(), referredBy(), maxId()

Examples

edges = createEdges(source = c(0,0), target = c(1,2))
refersTo(edges)

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