net.3dplot: 3D network plot of an adjacency matrix between pairs of...

View source: R/net.3dplot.R

net.3dplotR Documentation

3D network plot of an adjacency matrix between pairs of change points

Description

This function takes an adjacency matrix of a brain network and returns a 3D plot of it.

Usage

net.3dplot(A, ROIs = NULL, colors = NULL, coordROIs = NULL, labels = FALSE)

Arguments

A

An adjacency matrix to be plotted (in numerical matrix format).

ROIs

Either a vector of character strings specifying the communities to plot, or a vector of integers specifying which ROIs to plot by their ID. By default it is set to NULL, and all communities and ROIs are plotted. Communities available for the Gordon atlas are: "Default", "SMhand", "SMmouth", "Visual", "FrontoParietal", "Auditory", "None", "CinguloParietal", "RetrosplenialTemporal", "CinguloOperc", "VentralAttn", "Salience", and "DorsalAttn".

colors

A vector of character strings specifying the hex codes for node colors to distinguish each community. By default, each community is given a predefined, unique color.

coordROIs

A dataframe of community tags and Montreal Neurological Institute (MNI) coordinates for regions of interest (ROIs) to plot, which is by default set to NULL and uses the Gordon atlas. See ?gordon.atlas for an example using the Gordon atlas. Format of the dataframe is as follows: first column is a string of community labels, then the subsequent three columns are the x, y, and z coordinates, respectively. See AALatlas and gordatlas for examples.

labels

A boolean value denoting whether to add labels to nodes; if set to TRUE, this will add node labels to the plot, and if set to FALSE, will not. By default this is set to FALSE.

Value

A 3D network plot of an adjacency matrix between pairs of change points, or for data without change points.

Author(s)

Martin Ondrus, mondrus@ualberta.ca, Ivor Cribben, cribben@ualberta.ca

References

"Factorized Binary Search: a novel technique for change point detection in multivariate high-dimensional time series networks", Ondrus et al. (2021), <arXiv:2103.06347>.

Examples


## Plotting a 333 * 333 adjacency matrix "adjmatrix" with red, blue, and green
## nodes to denote the "Default", "SMhand", and "Visual" communities
comms = c("Default", "SMhand", "Visual")
colrs = c("#FF0000", "#00FF00", "#0000FF")
net.3dplot(adjmatrix, ROIs = comms, colors = colrs)



fabisearch documentation built on March 18, 2022, 6 p.m.