SeqNet (version 1.1.3)

rewire_connections.network_module: Rewire connections

Description

Rewire connections

Usage

# S3 method for network_module
rewire_connections(
  x,
  prob_rewire = 1,
  weights = NULL,
  alpha = 100,
  beta = 1,
  epsilon = 10^-5,
  run_checks = TRUE,
  ...
)

Arguments

x

The 'network', 'network_module', or 'matrix' object to modify.

prob_rewire

A value between 0 and 1. The connections to each node will be rewired with probability equal to prob_rewire.

weights

(Optional) A vector of weights for each node. These are used in addition to the degree of each node when sampling a node to rewire to.

alpha

A positive value used to parameterize the Beta distribution.

beta

A positive value used to parameterize the Beta distribution.

epsilon

A small constant added to the sampling probability of each node.

run_checks

If TRUE and 'x' is a matrix, then it is checked that 'x' is an adjacency matrix. This catches the case where 'x' is a weighted matrix, in which case the weights are removed and a warning is given.

...

Additional arguments.

Value

The modified module.

Examples

# NOT RUN {
# Create a random network with 10 nodes. 
nw <- random_network(10)
# Rewire nodes in the network each with probability 1/2
nw_rewired <- rewire_connections(nw, 0.5)
# Plot the two networks for comparison
g <- plot(nw)
plot(nw_rewired, g) # Pass in g to mirror the layout.
# Or plot the differential network.
plot_network_diff(nw, nw_rewired, g)
# }