validate: Validate RCX and its aspects

Description Usage Arguments Details Value Methods (by class) Examples

View source: R/Validate.R

Description

Validate RCX objects and its aspects.

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
validate(x, verbose = TRUE)

## Default S3 method:
validate(x, verbose = TRUE)

## S3 method for class 'NodesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'EdgesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'NodeAttributesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'EdgeAttributesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'NetworkAttributesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CartesianLayoutAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CyGroupsAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CyVisualPropertiesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CyVisualProperty'
validate(x, verbose = TRUE)

## S3 method for class 'CyVisualPropertyProperties'
validate(x, verbose = TRUE)

## S3 method for class 'CyVisualPropertyDependencies'
validate(x, verbose = TRUE)

## S3 method for class 'CyVisualPropertyMappings'
validate(x, verbose = TRUE)

## S3 method for class 'CyHiddenAttributesAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CyNetworkRelationsAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CySubNetworksAspect'
validate(x, verbose = TRUE)

## S3 method for class 'CyTableColumnAspect'
validate(x, verbose = TRUE)

## S3 method for class 'RCX'
validate(x, verbose = TRUE)

Arguments

x

object to validate; RCX object or an aspect

verbose

logical; whether to print the test results.

Details

Different tests are performed on aspects and the RCX network. This includes checks of the correct aspect structure, data types, uniqueness of IDs and attribute names, presence of NA values, and references between the aspects.

Value

logical; whether the object passed all tests.

Methods (by class)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Read from a CX file
## reading the provided example network of the package
cxFile <- system.file(
 "extdata", 
 "Imatinib-Inhibition-of-BCR-ABL-66a902f5-2022-11e9-bb6a-0ac135e8bacf.cx", 
 package = "RCX"
)

rcx = readCX(cxFile)

## validate the network
validate(rcx)

## validate a single aspect
validate(rcx$nodes)

frankkramer-lab/RCX documentation built on Feb. 8, 2022, 9:53 p.m.