Skip to contents

Wrapper function to generate label propagation parameters

Usage

params_label_propagation(
  alpha = 0.9,
  iter = 100L,
  tolerance = 1e-06,
  symmetrise = TRUE,
  symmetry_strategy = "average",
  max_hops = NULL
)

Arguments

alpha

Numeric. Controls the spreading strength. Higher values anchor labelled nodes more strongly to their original label. Defaults to 0.9.

iter

Integer. Maximum number of iterations to run. Defaults to 100L.

tolerance

Numeric. Convergence threshold. Stops early if the maximum change across all nodes falls below this value. Defaults to 1e-6.

symmetrise

Logical. Whether to symmetrise the graph. Defaults to TRUE.

symmetry_strategy

Character. Strategy to resolve weight conflicts when symmetrising. One of "average", "min", or "max". Only relevant when symmetrise = TRUE and edge weights are provided. Defaults to "average".

max_hops

Integer or NULL. If provided, restricts label spreading to nodes within this many hops of any labelled node. Nodes beyond this limit remain all-zeroes. Defaults to NULL.

Value

A named list of label propagation parameters.