inst/doc/ggseg.formats.R

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

## -----------------------------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

## -----------------------------------------------------------------------------
library(ggseg.formats)
# Several examples below print or plot via the sf path. Since the
# sf-optional milestone, sf is a Suggests dependency, so load it here.
library(sf)

## -----------------------------------------------------------------------------
dk()

## -----------------------------------------------------------------------------
dk()$atlas
dk()$type

## -----------------------------------------------------------------------------
head(dk()$palette)

## -----------------------------------------------------------------------------
head(dk()$core)

## -----------------------------------------------------------------------------
class(dk()$data)

## -----------------------------------------------------------------------------
dk()$type
names(dk()$data)

## -----------------------------------------------------------------------------
aseg()$type
names(aseg()$data)

## -----------------------------------------------------------------------------
tracula()$type
names(tracula()$data)

## -----------------------------------------------------------------------------
str(dk()$core)

## -----------------------------------------------------------------------------
unique(dk()$core$lobe)

## -----------------------------------------------------------------------------
atlas_regions(dk())

## -----------------------------------------------------------------------------
head(atlas_labels(dk()))

## -----------------------------------------------------------------------------
atlas_views(dk())
atlas_views(aseg())
atlas_views(tracula())

## -----------------------------------------------------------------------------
atlas_type(dk())
atlas_type(aseg())
atlas_type(tracula())

## -----------------------------------------------------------------------------
head(atlas_palette(dk()))

## -----------------------------------------------------------------------------
sf_data <- atlas_sf(dk())
sf_data

## -----------------------------------------------------------------------------
vert_data <- atlas_vertices(dk())
vert_data

## -----------------------------------------------------------------------------
mesh_data <- atlas_meshes(aseg())
mesh_data

## -----------------------------------------------------------------------------
df <- as.data.frame(dk())
names(df)

## -----------------------------------------------------------------------------
is_ggseg_atlas(dk())
is_ggseg_atlas(mtcars)

## -----------------------------------------------------------------------------
atlas_list <- as.list(dk())
recovered <- as_ggseg_atlas(atlas_list)
is_ggseg_atlas(recovered)