rich_club_attrs: Assign graph attributes based on rich-club analysis

View source: R/rich_club.R

rich_club_attrsR Documentation

Assign graph attributes based on rich-club analysis

Description

Assigns vertex- and edge-level attributes based on the results of a rich-club analysis, based on a range of vertex degrees in which the rich-club coefficient was determined to be significantly greater than that of a set of random graphs (see rich_club_norm).

Usage

rich_club_attrs(g, deg.range = NULL, adj.vsize = FALSE)

Arguments

g

An igraph graph object

deg.range

Numeric vector of the range of degrees indicating inclusion in the rich-club; if the default NULL, it will be from 1 to the maximum degree in the graph

adj.vsize

Logical indicating whether to adjust vertex size proportional to degree. Default: FALSE

Details

Vertices which are in the rich club will be assigned an attribute rich, taking on a binary value. Their colors (attribute color.rich) will be either red or gray. Their sizes (attribute size.rich) will either be 10 or will be proportional to their degree.

Edge attribute type.rich takes on three values: rich-club (if it connects two rich-club vertices), feeder (if it connects a rich- to a non-rich-club vertex), and local (if it connects two non-rich-club vertices). The color.rich attribute is red, orange, or green. Edge sizes (size.rich) will be largest for rich-club connections, then smaller for feeder, and smallest for local.

Value

An igraph graph object with additional attributes:

rich

Binary indicating membership in the rich-club

type.rich

Edge attribute indicating the type of connection

color.rich

Edge and vertex attributes

size.rich

Edge and vertex attributes

Author(s)

Christopher G. Watson, cgwatson@bu.edu

See Also

Other Rich-club functions: Rich Club, plot_rich_norm

Examples

## Not run: 
g <- rich_club_attrs(g, rich.dt[density == densities[N] & p.fdr < .01,
                                range(k)])

## End(Not run)

cwatson/brainGraph documentation built on Feb. 21, 2024, 6:33 p.m.