backbone.suggest {backbone}R Documentation

Suggest a backbone model

Description

backbone.suggest suggests and optionally runs an appropriate backbone model for a graph object.

Usage

backbone.suggest(G, s = NULL)

Arguments

G

graph: A graph represented in an object of class matrix, sparse Matrix, dataframe, or igraph.

s

numeric: If provided, a backbone is extracted using this value as the significance level or sparsification parameter.

Value

If s == NULL: NULL, but a message is displayed with a suggested model. If 0 <= s <= 1: A binary backbone graph in the same class as G, obtained by extracting the backbone at the s significance level (if a statistical model is suggested) or using sparisfication parameter s (if a sparsification model is suggested). The code used to perform the extraction, and suggested manuscript text are displayed.

References

Neal, Z. P. (2022). backbone: An R Package to Extract Network Backbones. PLOS ONE, 17, e0269137. doi: 10.1371/journal.pone.0269137

Examples

M <- matrix(runif(100),10,10)  #A random weighted, directed graph
backbone <- backbone.suggest(M)
backbone <- backbone.suggest(M, s = 0.05)

[Package backbone version 2.1.0 Index]