is.subcort_labs: Validate a factor vector of subcortical labels

View source: R/is.xifti.R

is.subcort_labsR Documentation

Validate a factor vector of subcortical labels

Description

Check if object is a factor vector of subcortical structures.This is a helper function for is.xifti.

Usage

is.subcort_labs(x)

Arguments

x

The putative factor vector of brain substructures.

Details

Requirements: see the "Label Levels" section for the expected factor levels.

Value

Logical. Is x a factor vector of subcortical structures?

Label Levels

xifti$meta$subcort$labels is a factor with the following levels:

  1. Cortex-L

  2. Cortex-R

  3. Accumbens-L

  4. Accumbens-R

  5. Amygdala-L

  6. Amygdala-R

  7. Brain Stem

  8. Caudate-L

  9. Caudate-R

  10. Cerebellum-L

  11. Cerebellum-R

  12. Diencephalon-L

  13. Diencephalon-R

  14. Hippocampus-L

  15. Hippocampus-R

  16. Pallidum-L

  17. Pallidum-R

  18. Putamen-L

  19. Putamen-R

  20. Thalamus-L

  21. Thalamus-R

These correspond to the same structures as given by ft_read_cifti in the cifti-matlab MATLAB toolbox. Note that the first two levels (left and right cortex) are not used.


ciftiTools documentation built on Oct. 4, 2024, 1:12 a.m.