maxId: Highest ID of an aspect

View source: R/AspectDependencies.R

maxIdR Documentation

Highest ID of an aspect

Description

This function returns the highest id used in an aspect, that has ids. As example, the aspect NodesAspect has the property id that must be a unique positive integer.

Usage

maxId(x)

## Default S3 method:
maxId(x)

## S3 method for class 'RCX'
maxId(x)

Arguments

x

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

Details

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

Value

integer; Highest id. For RCX objects all highest ids are returned in the vector named by the aspect class.

See Also

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

Examples

nodes = createNodes(name = c("ĆDK1","CDK2","CDK3"))
maxId(nodes)

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