vis.group.coloredmeshes: Plot coloredmeshes for a group of subjects.

View source: R/vis_group.R

vis.group.coloredmeshesR Documentation

Plot coloredmeshes for a group of subjects.

Description

Plot coloredmeshes for a group of subjects into a single image.

Usage

vis.group.coloredmeshes(
  coloredmeshes,
  view_angles = "sd_dorsal",
  output_img = "fsbrain_group_annot.png",
  num_per_row = 5L,
  captions = NULL,
  background_color = "white"
)

Arguments

coloredmeshes

a list of coloredmeshes lists, each entry in the outer list contains the hemilist of coloredmeshes (lefgt and right hemisphere mesh) for one subject.

view_angles

see get.view.angle.names.

output_img

character string, the file path for the output image. Should end with '.png'.

num_per_row

positive integer, the number of tiles per row.

captions

optional vector of character strings, the short text annotations for the individual tiles. Typically used to plot the subject identifier.

background_color

color for image background (transparency is not supported).

Value

named list, see the return value of arrange.brainview.images.grid for details.

Note

This is a mid-level function, end users may want to call high-level functions like vis.group.annot instead.

See Also

Other group visualization functions: vis.data.on.group.native(), vis.data.on.group.standard(), vis.group.annot(), vis.group.morph.native(), vis.group.morph.standard()


dfsp-spirit/nitools documentation built on Jan. 26, 2024, 8:24 p.m.