effective_information: Effective Information

Description Usage Arguments Value Examples

View source: R/effective_information.R

Description

Calculates the effective information (EI) of a network, G, according to the definition provided in Klein & Hoel, 2019. Here, we subtract the average entropies of the out-weights of nodes in a network, WOUT_average from the entropy of the average out-weights in the network, WIN_entropy.

Usage

1
effective_information(graph, effectiveness = FALSE)

Arguments

graph

igraph or matrix object.

effectiveness

Logical indicating whether or not to return network effectiveness.

Value

Numeric value indicating the effective information of the network.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
graph <- matrix(
  cbind(
    c(0.0, 1.0, 0.0, 0.0),
    c(0.0, 0.0, 1.0, 0.0),
    c(0.0, 0.0, 0.0, 1.0),
    c(0.0, 0.0, 0.0, 0.0)
  ),
 nrow = 4
) %>%
  igraph::graph.adjacency(mode = "directed")

effective_information(graph)

einet documentation built on April 24, 2020, 1:06 a.m.