brainGraph (version 1.0.0)

set_brainGraph_attr: Set graph, vertex, and edge attributes common in MRI analyses

Description

This function sets a number of graph, vertex, and edge attributes for a given igraph graph object. These are all measures that are common in MRI analyses of brain networks.

Usage

set_brainGraph_attr(g, atlas = NULL, modality = NULL, subject = NULL,
  group = NULL, rand = FALSE, use.parallel = TRUE, A = NULL)
set.brainGraph.attributes(g, atlas = NULL, modality = NULL,
  subject = NULL, group = NULL, rand = FALSE, use.parallel = TRUE)

Arguments

g

An igraph graph object

atlas

Character vector indicating which atlas was used (default: NULL)

modality

Character vector indicating imaging modality (e.g. 'dti') (default: NULL)

subject

Character vector indicating subject ID (default: NULL)

group

Character vector indicating group membership (default: NULL)

rand

Logical indicating if the graph is random or not (default: FALSE)

use.parallel

Logical indicating whether or not to use foreach (default: TRUE)

A

Numeric matrix; the (weighted) adjacency matrix, which can be used for faster calculation of local efficiency (default: NULL)

Value

g An igraph graph object with the following attributes:

Graph-level

Package version, atlas, density, connected component sizes, diameter, \# of triangles, transitivity, average path length, assortativity, clique number, global & local efficiency, modularity, vulnerability, hub score, rich-club coefficient, \# of hubs, edge asymmetry, and modality

Vertex-level

Degree, strength, betweenness/eigenvector and leverage centralities, hubs, transitivity (local), coreness, local & nodal efficiency, color (community), color (lobe), color (component), membership (community), membership (component), gateway and participation coefficients, within-module degree z-score, vulnerability, and coordinates (x, y, and z)

Edge-level

Color (community), color (lobe), color (component), edge betweenness, Euclidean distance (in mm)

See Also

components, diameter, clique_num, centr_betw, part_coeff, edge.betweenness, centr_eigen, gateway_coeff, hub.score, authority.score, transitivity, mean_distance, assortativity.degree, cluster_louvain, efficiency, set_edge_color, rich_club_coeff, within_module_deg_z_score, coreness, edge_spatial_dist, vulnerability, centr_lev, edge_asymmetry, graph.knn, vertex_spatial_dist