qdecr_snap: Opens Freeview to take snapshots

Description Usage Arguments Details

View source: R/plotting.R

Description

Opens Freeview to take snapshots and compiles them into a plot

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
qdecr_snap(
  vw,
  stack = NULL,
  type = c("coef", "se", "t", "p"),
  ext = ".tiff",
  zoom = 1,
  compose = TRUE,
  plot_brain = TRUE,
  save_plot = TRUE,
  sig = TRUE,
  ...
)

Arguments

vw

The output object of a qdecr call (e.g. qdecr_fastlm)

stack

Either a numeric or a string for your variable (use 'stacks(vw)')

type

The type of map to plot (currently for OLS). Default is 'coef', others are 'se', 't' and 'p'

ext

Extension of the image files that will be stored on disk

zoom

Float that determines how far the brains are zoomed in

compose

Logical; if TRUE, a single compiled image will be made (requires Magick++)

plot_brain

Logical; if TRUE, returns a graphical device with the composed images

save_plot

Logical; if TRUE, saves the composed image

sig

Logical; if TRUE, only the significant clusters are shown

...

any arguments that freeview (on command line) normally takes for manipulating surface files

Details

This function directly calls Freeview and generates files (by default .tiff) and additionally composes the images and plots them. Magick++ is required for the composing step (see www.qdecr.com).


slamballais/QDECR documentation built on Jan. 9, 2022, 1:22 p.m.