icon_test: icon_test

Description Usage Arguments Details Value Examples

View source: R/interconnectivity_functions.R

Description

"icon" is an abbreviation for the "interconnectivity" of a network or graph.

Usage

1
icon_test(nodes1 = NULL, nodes2 = NULL, s = 100, verbose = TRUE, ...)

Arguments

nodes1

[NULL] the first network. See network_overlap().

nodes2

[NULL] the second network. See network_overlap().

s

[100] the number of random permutations to make.

verbose

[TRUE] Extent of text shown in the console.

...

Additional argumetns are passed on to the specific test performed

Details

This function handles different inputs and directs them to the appropriate "icon" testing method. Depending on the values given to "nodes1" and "nodes2," a different specific test is performed.

Note that the specific functions called make use of the "param" attribute of each input. These parameters are populated by network_overlap() so that the permutation reflects the exact procedure that was done to generate "nodes1" and/or "nodes2."

Value

metrics and significance of the network overlap

Examples

1
2
3
4
## Not run: 
icon_test( nodes1=n, s=10)

## End(Not run)

RITAN documentation built on Nov. 8, 2020, 8:16 p.m.