Functions for accessing and filtering ROI (Region of Interest) metadata in atlas objects. These functions provide a unified, discoverable interface for working with multiple ROI attributes across different atlas types.
Returns a tibble containing metadata for all regions of interest (ROIs) in an atlas. This provides a unified, tidy interface for accessing ROI attributes across different atlas types.
Value
A tibble with one row per ROI and columns for each attribute. Standard columns include:
- id
Numeric ROI identifier
- label
Simplified region name
- label_full
Original/full region label
- hemi
Hemisphere ("left", "right", or NA for bilateral/midline)
- color_r, color_g, color_b
RGB color values (0-255)
- template_space
Template space identifier (e.g., "MNI152NLin6Asym"), when atlas_ref is available
- coord_space
Coordinate space (e.g., "MNI152", "MNI305"), when atlas_ref is available
- atlas_family
Atlas family identifier (e.g., "schaefer"), when atlas_ref is available
Additional atlas-specific columns may be present (e.g., network for Schaefer atlases).
See also
roi_attributes for listing available attributes,
filter_atlas for filtering atlas objects by attributes
Examples
if (FALSE) { # \dontrun{
# Get metadata for Schaefer atlas
atlas <- get_schaefer_atlas(parcels = "200", networks = "7")
meta <- roi_metadata(atlas)
# Filter using dplyr
library(dplyr)
left_visual <- meta %>% filter(hemi == "left", network == "Vis")
} # }