netclu_walktrap {bioregion} | R Documentation |
Community structure detection via short random walks
Description
This function finds communities in a (un)weighted undirected network via short random walks.
Usage
netclu_walktrap(
net,
weight = TRUE,
cut_weight = 0,
index = names(net)[3],
steps = 4,
bipartite = FALSE,
site_col = 1,
species_col = 2,
return_node_type = "both",
algorithm_in_output = TRUE
)
Arguments
net |
the output object from |
weight |
a |
cut_weight |
a minimal weight value. If |
index |
name or number of the column to use as weight. By default,
the third column name of |
steps |
the length of the random walks to perform. |
bipartite |
a |
site_col |
name or number for the column of site nodes (i.e. primary nodes). |
species_col |
name or number for the column of species nodes (i.e. feature nodes). |
return_node_type |
a |
algorithm_in_output |
a |
Details
This function is based on random walks (Pons and Latapy 2005) as implemented in the igraph package (cluster_walktrap).
Value
A list
of class bioregion.clusters
with five slots:
name:
character
containing the name of the algorithmargs:
list
of input arguments as provided by the userinputs:
list
of characteristics of the clustering processalgorithm:
list
of all objects associated with the clustering procedure, such as original cluster objects (only ifalgorithm_in_output = TRUE
)clusters:
data.frame
containing the clustering results
In the algorithm
slot, if algorithm_in_output = TRUE
, users can
find the output of
cluster_walktrap.
Note
Although this algorithm was not primarily designed to deal with bipartite
network, it is possible to consider the bipartite network as unipartite
network (bipartite = TRUE
).
Do not forget to indicate which of the first two columns is
dedicated to the site nodes (i.e. primary nodes) and species nodes (i.e.
feature nodes) using the arguments site_col
and species_col
.
The type of nodes returned in the output can be chosen with the argument
return_node_type
equal to both
to keep both types of nodes,
sites
to preserve only the sites nodes and species
to
preserve only the species nodes.
Author(s)
Maxime Lenormand (maxime.lenormand@inrae.fr), Pierre Denelle (pierre.denelle@gmail.com) and Boris Leroy (leroy.boris@gmail.com)
References
Pons P, Latapy M (2005). “Computing Communities in Large Networks Using Random Walks.” In Yolum I, Güngör T, Gürgen F, Özturan C (eds.), Computer and Information Sciences - ISCIS 2005, Lecture Notes in Computer Science, 284–293.
Examples
comat <- matrix(sample(1000, 50), 5, 10)
rownames(comat) <- paste0("Site", 1:5)
colnames(comat) <- paste0("Species", 1:10)
net <- similarity(comat, metric = "Simpson")
com <- netclu_walktrap(net)
net_bip <- mat_to_net(comat, weight = TRUE)
clust2 <- netclu_walktrap(net_bip, bipartite = TRUE)