rleiden.community {leidenAlg}

Recursive leiden communities Constructs an n-step recursive clustering, using leiden.community

Description

Recursive leiden communities Constructs an n-step recursive clustering, using leiden.community

Usage

rleiden.community(
  graph,
  max.depth = 2,
  n.cores = parallel::detectCores(logical = FALSE),
  min.community.size = 10,
  verbose = FALSE,
  resolution = 1,
  cur.depth = 1,
  hierarchical = TRUE,
  ...
)

Arguments

graph

graph

max.depth

Recursive depth (default=2)

n.cores

integer Number of cores to use (default = parallel::detectCores(logical=FALSE)). If logical=FALSE, uses the number of physical CPUs/cores. If logical=TRUE, uses the logical number of CPUS/cores. See parallel::detectCores()

min.community.size

integer Minimal community size parameter for the walktrap communities—Communities smaller than that will be merged (default=10)

verbose

boolean Whether to output progress messages (default=FALSE)

resolution

resolution parameter passed to leiden.community (either a single value, or a value equivalent to max.depth) (default=1)

cur.depth

integer Current depth of clustering (default=1)

hierarchical

boolean If TRUE, calculate hierarchy on the multilevel clusters (default=TRUE)

...

passed to leiden.community

Value

a fakeCommunities object that returns membership and dendrogram

Examples

rleiden.community(exampleGraph, n.cores=1)