summary: RCX and aspect summary

Description Usage Arguments Details Methods (by class) Examples

Description

summary is a generic function used to produce result summaries of the RCX object. The function invokes particular methods which depend on the class of the first argument.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
## S3 method for class 'RCX'
summary(object, ...)

## S3 method for class 'MetaDataAspect'
summary(object, ...)

## S3 method for class 'NodesAspect'
summary(object, ...)

## S3 method for class 'EdgesAspect'
summary(object, ...)

## S3 method for class 'NodeAttributesAspect'
summary(object, ...)

## S3 method for class 'EdgeAttributesAspect'
summary(object, ...)

## S3 method for class 'NetworkAttributesAspect'
summary(object, ...)

## S3 method for class 'CartesianLayoutAspect'
summary(object, ...)

## S3 method for class 'CyGroupsAspect'
summary(object, ...)

## S3 method for class 'CyHiddenAttributesAspect'
summary(object, ...)

## S3 method for class 'CyNetworkRelationsAspect'
summary(object, ...)

## S3 method for class 'CySubNetworksAspect'
summary(object, ...)

## S3 method for class 'CyTableColumnAspect'
summary(object, ...)

## S3 method for class 'CyVisualPropertiesAspect'
summary(object, ...)

## S3 method for class 'CyVisualProperty'
summary(object, ...)

## S3 method for class 'AspectIdColumn'
summary(object, ...)

## S3 method for class 'AspectRefColumn'
summary(object, ...)

## S3 method for class 'AspectReqRefColumn'
summary(object, ...)

## S3 method for class 'AspectValueColumn'
summary(object, ...)

## S3 method for class 'AspectAttributeColumn'
summary(object, ...)

## S3 method for class 'AspectListLengthColumn'
summary(object, ...)

Arguments

object

an object; RCX object or aspect (or column of data.frame)

...

additional arguments affecting the summary produced.

Details

The form of the returned summary depends on the class of its argument, therefore it is possible to summarize RCX objects and their single aspects.

To enhance readability of the summary, some additional classes have summary functions, that are used to show for example ids of an aspect, required and optional references to ids of aspects, or the number of elements in lists.

Methods (by class)

Examples

1
2
3
4
5
6
rcx = createRCX(
  nodes = createNodes(name = c("a","b","c")),
  edges = createEdges(source=1, target=2)
)

summary(rcx)

frankkramer-lab/RCX documentation built on Oct. 26, 2021, 1:33 a.m.