brain_viz: Brain Visual

Description Usage Arguments

View source: R/brain_viz.R

Description

Provides a 'ggplot2' figure of the connections of regions of the brain.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
brain_viz(
  obj,
  jitter_val = 0.04,
  view = "side",
  image = NULL,
  regs = NULL,
  diff = 0,
  colors = NULL,
  alpha = 0.001
)

Arguments

obj

from 'get_connectivity()'

jitter_val

control how far away the overlapping lines are (default is .04)

view

the view of the brain diagram (available options are "side", "top", "right", "left"). If the image argument is given a path, then that image will be used instead of the built-in ones.

image

If NULL then the default images (based on 'view'); otherwise the path to the figure should be supplied here

regs

Alternate locations for the regions of interest (needs to have x, y, and region as the variables)

diff

For comparison brain viz's, this is the difference between the largest effect size of one to the other (current sample - comparison sample). Adjusts the size of the arrows to be more comparable across samples.

colors

If NULL, then it colored based on outcome region. Otherwise can define based on the 'get_connectivity()' object.

alpha

the alpha level for significance


TysonStanley/connectivity documentation built on March 15, 2020, 1:44 a.m.