Package: ggseg.formats 0.0.4.9026

Athanasia Mo Mowinckel

ggseg.formats: Brain Atlas Data Structures for the 'ggsegverse' Ecosystem

Provides the 'ggseg_atlas' S3 class used across the 'ggsegverse' ecosystem for 2D and 3D brain visualisation. Ships four bundled atlases ('Desikan-Killiany', 'FreeSurfer' 'aseg', 'TRACULA', 'SUIT') and functions for querying, subsetting, renaming, and enriching atlas objects. Also includes readers for 'FreeSurfer' statistics files.

Authors:Athanasia Mo Mowinckel [aut, cre], Center for Lifespan Changes in Brain and Cognition, University of Oslo [cph]

ggseg.formats_0.0.4.9026.tar.gz
ggseg.formats_0.0.4.9026.zip(r-4.7-any)ggseg.formats_0.0.4.9026.zip(r-4.6-any)ggseg.formats_0.0.4.9026.zip(r-4.5-any)
ggseg.formats_0.0.4.9026.tgz(r-4.6-any)ggseg.formats_0.0.4.9026.tgz(r-4.5-any)
ggseg.formats_0.0.4.9026.tar.gz(r-4.7-any)ggseg.formats_0.0.4.9026.tar.gz(r-4.6-any)
ggseg.formats_0.0.4.9026.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ggseg.formats/json (API)

# Install 'ggseg.formats' in R:
install.packages('ggseg.formats', repos = c('https://ggsegverse.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ggsegverse/ggseg.formats/issues

Pkgdown/docs site:https://ggsegverse.github.io

On CRAN:

Conda:

9.25 score 22 packages 91 scripts 944 downloads 9 mentions 90 exports 6 dependencies

Last updated from:6e4e64a386. Checks:9 OK. Indexed: yes.
A new build is currently in progress.

TargetResultTimeFilesSyslog
linux-develOK175
source / vignettesOK241
linux-releaseOK164
macos-releaseOK155
macos-oldrelOK136
windows-develOK139
windows-releaseOK144
windows-oldrelOK148
wasm-releaseOK124

Exports:as_brain_atlasas_ggseg_atlasas_polygon_atlasas_sf_atlasasegassert_ggseg_atlasatlas_centerlinesatlas_contextatlas_context_removeatlas_core_addatlas_displayatlas_geomatlas_geometry_typeatlas_hemiatlas_labelsatlas_meshesatlas_paletteatlas_plot_paletteatlas_polygonsatlas_provenanceatlas_prune_regionatlas_prune_smallatlas_prune_weakatlas_region_contextualatlas_region_keepatlas_region_opatlas_region_removeatlas_region_renameatlas_region_semanticsatlas_regionsatlas_relabelatlas_sfatlas_structure_reorderatlas_typeatlas_undrawnatlas_verticesatlas_view_gatheratlas_view_keepatlas_view_removeatlas_view_remove_regionatlas_view_remove_smallatlas_view_reorderatlas_view_selectatlas_viewsatlas_views_emptyattach_sfcbrain_atlasbrain_data_corticalbrain_data_subcorticalbrain_data_tractbrain_labelsbrain_regionsbrain_viewscontextconvert_legacy_brain_atlasdkget_brain_meshget_cerebellar_meshggseg_atlasggseg_data_cerebellarggseg_data_corticalggseg_data_subcorticalggseg_data_tractggseg_data_wmis_atlas_polygonis_atlas_sfis_brain_atlasis_cerebellar_atlasis_cortical_atlasis_ggseg_atlasis_ggseg3d_atlasis_subcortical_atlasis_tract_atlasis_wm_atlaslegacy_region_mapmigrate_atlas_displaymigrate_atlas_filesmigrate_atlas_hemiread_atlas_filesread_freesurfer_statsread_freesurfer_tableregionsrelabel_atlasreorder_sfcset_atlas_paletteset_atlas_provenanceset_atlas_typesuittraculaunify_legacy_atlases

Dependencies:cligeometrieslifecycleRcpprlangsfheaders

Customising brain atlases
The manipulation toolkit | Keeping and removing regions | Context regions | Renaming regions | Managing views | Cleaning up geometry | Reordering and gathering | Adding metadata | A full pipeline

Last update: 2026-11-11
Started: 2026-02-09

Migrating atlases and code
Migrating code to the 0.1.0 region keys | Do not use display for this | The accessors return rows, not a set | Adding display to your own atlas | label must be unique | 2D coverage is not validated | Migrating an atlas package to sf-optional | The recipe | What migrate_atlas_files() does | Keeping sf instead | Verifying the result

Last update: 2026-10-12
Started: 2026-06-11

The ggseg_atlas object
What is a ggseg_atlas? | Anatomy of an atlas | Three atlas types | Core: the region table | Querying an atlas | Extracting render-ready data | Checking and converting

Last update: 2026-10-12
Started: 2026-02-09

Readme and manuals

Help Manual

Help pageTopics
Coerce to ggseg atlasas_brain_atlas as_ggseg_atlas
Convert a ggseg atlas to the sf-optional polygon representationas_polygon_atlas
Rehydrate a ggseg atlas into sf-backed formas_sf_atlas
FreeSurfer Automatic Subcortical Segmentation Atlasaseg
Require a valid ggseg atlas, reporting why it is notassert_ggseg_atlas
Get atlas tract centerlinesatlas_centerlines
The labels an atlas draws but does not treat as regionsatlas_context
Join additional metadata columns to an atlas's coreatlas_core_add
Extract the display-name column of an atlasatlas_display
Get the raw 2D geometry of an atlasatlas_geom
Classify or test an atlas's 2D geometryatlas_geometry_type is_atlas_polygon is_atlas_sf
Extract the hemisphere column of an atlasatlas_hemi
Extract the label column of an atlasatlas_labels brain_labels
Manipulate brain atlas regions, views and drawingsatlas_manipulation
Get atlas meshes for 3D renderingatlas_meshes
Get the palette of an atlasatlas_palette
Get a plottable palette for an atlasatlas_plot_palette
Get atlas polygons for 2D renderingatlas_polygons
How an atlas was builtatlas_provenance
Does this atlas's 'region' aggregate across hemispheres?atlas_region_semantics
Extract the region column of an atlasatlas_regions brain_regions
Re-key an atlas's labelsatlas_relabel relabel_atlas
Get atlas data for 2D renderingatlas_sf
Reorder the structures of an atlasatlas_structure_reorder
Detect atlas typeatlas_type
The regions an atlas names but never drawsatlas_undrawn
Get atlas vertices for 3D renderingatlas_vertices
Get available views in atlasatlas_views brain_views
The views an atlas has that draw no regionatlas_views_empty
Attach an 'sfc' column and class a data frame as 'sf', without sfattach_sfc
Convert legacy ggseg atlases to ggseg_atlas formatconvert_legacy_brain_atlas unify_legacy_atlases
What an atlas's three name columns meancore_contract
Desikan-Killiany Cortical Atlasdk
Change which regions are drawn inside a viewatlas_prune_region atlas_prune_small atlas_prune_weak atlas_view_remove_region atlas_view_remove_small atlas_view_select drawing_manipulation
Get brain surface meshget_brain_mesh
Get SUIT cerebellar surface meshget_cerebellar_mesh
Constructor for ggseg atlasbrain_atlas ggseg_atlas
Create cerebellar atlas dataggseg_data_cerebellar
Create cortical atlas databrain_data_cortical ggseg_data_cortical
Create subcortical atlas databrain_data_subcortical ggseg_data_subcortical
Create tract atlas databrain_data_tract ggseg_data_tract
Create white-matter atlas dataggseg_data_wm
Check ggseg atlas classis_brain_atlas is_cerebellar_atlas is_cortical_atlas is_ggseg_atlas is_subcortical_atlas is_tract_atlas is_wm_atlas
Check if object is a legacy ggseg3d atlasis_ggseg3d_atlas
Map pre-0.1.0 region names to current region keyslegacy_region_map
Give an atlas built before 'display' existed its display namesmigrate_atlas_display
Migrate atlas '.rda' files to the sf-optional polygon formatmigrate_atlas_files
Map a legacy 'hemi' spelling onto the vocabularymigrate_atlas_hemi
Read in atlas data from all subjectsread_atlas_files
Read in raw FreeSurfer stats fileread_freesurfer_stats
Read in stats table from FreeSurferread_freesurfer_table
Change which regions an atlas hasatlas_context_remove atlas_region_contextual atlas_region_keep atlas_region_op atlas_region_remove atlas_region_rename region_manipulation
Reorder an 'sfc' without sfreorder_sfc
Select an atlas's backdrop, or its regions, in a geometry verbcontext regions selectors
Set the palette of an atlasset_atlas_palette
Record how an atlas was builtset_atlas_provenance
Set the type of an atlasset_atlas_type
SUIT Cerebellar Lobular Atlassuit
TRACULA White Matter Tract Atlastracula
Change which views an atlas has, and where they sitatlas_view_gather atlas_view_keep atlas_view_remove atlas_view_reorder view_manipulation