Random.Walk.Restart.Multiplex: Performs Random Walk with Restart on a Multiplex Network

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/RWRandMatrices.R

Description

Random.Walk.Restart.Multiplex is a function to perform a Random Walk with Restart on a Multiplex network (on a Multiplex object). See more details about the algorithm below.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
Random.Walk.Restart.Multiplex(...)

## Default S3 method:
Random.Walk.Restart.Multiplex(
  x,
  MultiplexObject,
  Seeds,
  r = 0.7,
  tau,
  MeanType = "Geometric",
  DispResults = "TopScores",
  ...
)

Arguments

...

Further arguments passed to Random.Walk.Restart.Multiplex

x

An object of the Matrix package describing a column normalized adjacency matrix of a multiplex network.

MultiplexObject

A Multiplex object generated by the function create.multiplex representing a multiplex network.

Seeds

A vector containing the names of the seeds for the Random Walk algorithm. See more details below.

r

A numeric value between 0 and 1. It sets the probability of restarting to a seed node after each step. See more details below.

tau

A vector containing the probability of restart on the seeds of the different layers (layers weights). It must have the same length than the number of layers of the multpiplex network. The sum of its components divided by the number of layers must be 1. See more details below.

MeanType

The user can choose one of the following options: c("Geometric","Arithmetic","Sum"). These options represent the different way to combine the RWR score for the same node in different layers. By default and recommended Geometric (Geometric Mean.). Arithmetic is the arithmetic mean and sum just sum all the scores for the same node across the different layers.

DispResults

The user can choose one of the following options: c("TopScores","Alphabetic"). These options represent the way the RWR results would be presented. By default, and recommended, the nodes would be ordered by score. This option is also required to properly run the create.multiplexNetwork.topResults and create.multiplexHetNetwork.topResults functions

Details

Random Walk with Restart simulates an imaginary particle that starts on a seed(s) node(s) and follows randomly the edges of a network. At each step, there is a restart probability, r, meaning that the particle comes back to the seed(s). The extension to multiplex networks allows the particle to explore different monoplex networks (layers). At each step, the particle can also jump to the same node in a different layer.

Value

A RWRM_Results object. It contains a sorted ranking of all the nodes of the multiplex network, except the seeds, along with their score. In addition, it contains in a different field the nodes used as seeds.

Author(s)

Alberto Valdeolivas Urbelz alvaldeolivas@gmail.com

See Also

create.multiplex, compute.adjacency.matrix, normalize.multiplex.adjacency, isRWRM_Results, Random.Walk.Restart.MultiplexHet

Examples

1
2
3
4
5
6
7
m1 <- igraph::graph(c(1,2,1,3,2,3), directed = FALSE)
m2 <- igraph::graph(c(1,3,2,3,3,4,1,4), directed = FALSE)
multiObject <- create.multiplex(list(m1=m1,m2=m2))
AdjMatrix <- compute.adjacency.matrix(multiObject)
AdjMatrixNorm <- normalize.multiplex.adjacency(AdjMatrix)
SeedNodes <- c(1)
Random.Walk.Restart.Multiplex(AdjMatrixNorm,multiObject,SeedNodes)

alberto-valdeolivas/RandomWalkRestartMH documentation built on Aug. 12, 2021, 8:49 p.m.