robinRobustFast: robinRobustFast

View source: R/ROBINFast.R

robinRobustFastR Documentation

robinRobustFast

Description

This functions implements a procedure to examine the stability of the partition recovered by some algorithm against random perturbations of the original graph structure.

Usage

robinRobustFast(
  graph,
  graphRandom,
  method = c("walktrap", "edgeBetweenness", "fastGreedy", "louvain", "spinglass",
    "leadingEigen", "labelProp", "infomap", "optimal", "leiden", "other"),
  ...,
  FUN1 = NULL,
  measure = c("vi", "nmi", "split.join", "adjusted.rand"),
  seed = NULL,
  verbose = TRUE,
  BPPARAM = NULL
)

Arguments

graph

The output of prepGraph.

graphRandom

The output of random function.

method

The clustering method, one of "walktrap", "edgeBetweenness", "fastGreedy", "louvain", "spinglass", "leadingEigen", "labelProp", "infomap", "leiden","optimal".

...

other parameter

FUN1

in case the @method parameter is "other" there is the possibility to use a personal function passing its name through this parameter. The personal parameter has to take as input the @graph and the @weights (that can be NULL), and has to return a community object.

measure

The stability measure, one of "vi", "nmi", "split.join", "adjusted.rand" all normalized and used as distances. "nmi" refers to 1- nmi and "adjusted.ran" refers to 1-adjusted.rand.

seed

set seed (default seed=NULL)

verbose

flag for verbose output (default as TRUE)

BPPARAM

optional BiocParallel parameter object. If NULL (default), uses parallel::mclapply on Unix/macOS or sequential lapply on Windows. If a BiocParallel object is supplied and the BiocParallel package is installed, it will be used instead.

Value

A list object with two matrices: - the matrix "Mean" with the means of the procedure for the graph - the matrix "MeanRandom" with the means of the procedure for the random graph.


robin documentation built on Nov. 18, 2026, 1:08 a.m.