Package index • ggseg.formats

ggseg atlas

Create and inspect ggseg atlas objects.

ggseg_atlas() brain_atlas(): Constructor for ggseg atlas
ggseg_data_cortical() brain_data_cortical(): Create cortical atlas data
ggseg_data_subcortical() brain_data_subcortical(): Create subcortical atlas data
ggseg_data_tract() brain_data_tract(): Create tract atlas data
is_ggseg3d_atlas(): Check if object is a legacy ggseg3d atlas
is_ggseg_atlas() is_cortical_atlas() is_subcortical_atlas() is_tract_atlas() is_brain_atlas(): Check ggseg atlas class
as_ggseg_atlas() as_brain_atlas(): Coerce to ggseg atlas

Convert old ggseg/ggseg3d atlases to the unified ggseg_atlas format.

convert_legacy_brain_atlas() unify_legacy_atlases() superseded: Convert legacy ggseg atlases to ggseg_atlas format
as_ggseg_atlas() as_brain_atlas(): Coerce to ggseg atlas
atlas_labels() brain_labels(): Extract unique labels from an atlas
atlas_regions() brain_regions(): Extract unique region names from an atlas
atlas_views() brain_views(): Get available views in atlas
get_brain_mesh(): Get brain surface mesh
ggseg_atlas() brain_atlas(): Constructor for ggseg atlas
ggseg_data_cortical() brain_data_cortical(): Create cortical atlas data
ggseg_data_subcortical() brain_data_subcortical(): Create subcortical atlas data
ggseg_data_tract() brain_data_tract(): Create tract atlas data
is_ggseg_atlas() is_cortical_atlas() is_subcortical_atlas() is_tract_atlas() is_brain_atlas(): Check ggseg atlas class

Query atlas contents without reaching into slots directly.

atlas_labels() brain_labels(): Extract unique labels from an atlas
atlas_region_remove() atlas_region_contextual() atlas_region_rename() atlas_region_keep() atlas_core_add() atlas_view_remove() atlas_view_keep() atlas_view_remove_region() atlas_view_remove_small() atlas_view_gather() atlas_view_reorder(): Manipulate brain atlas regions and views
atlas_meshes(): Get atlas meshes for 3D rendering
atlas_palette(): Get atlas palette
atlas_regions() brain_regions(): Extract unique region names from an atlas
atlas_sf(): Get atlas data for 2D rendering
atlas_type(): Detect atlas type
atlas_vertices(): Get atlas vertices for 3D rendering
atlas_views() brain_views(): Get available views in atlas

Pipe-friendly functions for subsetting regions, managing views, and enriching metadata. All return a new ggseg_atlas.

atlas_region_remove() atlas_region_contextual() atlas_region_rename() atlas_region_keep() atlas_core_add() atlas_view_remove() atlas_view_keep() atlas_view_remove_region() atlas_view_remove_small() atlas_view_gather() atlas_view_reorder(): Manipulate brain atlas regions and views

Ready-to-use atlases shipped with the package.

Read FreeSurfer statistics files into R.