Skip to content

Commit b0d14d5

Browse files
committed
docs: clarify that Infomap considers edge directions
1 parent a84e7e5 commit b0d14d5

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

R/community.R

+3-2
Original file line numberDiff line numberDiff line change
@@ -1988,12 +1988,13 @@ cluster_optimal <- function(graph, weights = NULL) {
19881988
#' Infomap community finding
19891989
#'
19901990
#' Find community structure that minimizes the expected description length of a
1991-
#' random walker trajectory
1991+
#' random walker trajectory. If the graph is directed, edge directions will
1992+
#' be taken into account.
19921993
#'
19931994
#' Please see the details of this method in the references given below.
19941995
#'
19951996
#' @aliases infomap.community
1996-
#' @param graph The input graph.
1997+
#' @param graph The input graph. Edge directions will be taken into account.
19971998
#' @param e.weights If not `NULL`, then a numeric vector of edge weights.
19981999
#' The length must match the number of edges in the graph. By default the
19992000
#' \sQuote{`weight`} edge attribute is used as weights. If it is not

man/cluster_infomap.Rd

+3-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)