vis.group.annot {fsbrain} | R Documentation |
Plot atlas annotations for a group of subjects.
Description
Plot atlas annotations for a group of subjects and combine them into a single large image.
Usage
vis.group.annot(
subjects_dir,
subject_id,
atlas,
view_angles = "sd_dorsal",
output_img = "fsbrain_group_annot.png",
num_per_row = 5L,
captions = subject_id,
rglactions = list(no_vis = TRUE),
...
)
Arguments
subjects_dir |
string. The FreeSurfer SUBJECTS_DIR, i.e., a directory containing the data for all your subjects, each in a subdir named after the subject identifier. |
subject_id |
vector of character strings, the subject identifiers |
atlas |
vector of character strings, the atlas names. Example: |
view_angles |
see |
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. |
rglactions |
named list. A list in which the names are from a set of pre-defined actions. The values can be used to specify parameters for the action. The following example clips outliers in the data before plotting and writes a screenshot in PNG format: |
... |
extra parameters passed to the subject level visualization function. Not all may make sense in this context. Example: |
Value
named list, see the return value of arrange.brainview.images.grid
for details.
Note
The subjects are plotted row-wise, in the order in which they appear in the 'subject_id' parameter. This function is vectorized over 'subject_id' and 'atlas'.
See Also
Other group visualization functions:
vis.data.on.group.native()
,
vis.data.on.group.standard()
,
vis.group.coloredmeshes()
,
vis.group.morph.native()
,
vis.group.morph.standard()