R/regions.R

In TysonStanley/connectivity: Tools to Assess Brain Connectivity

#' Regions Side default
#'
#' The default list of regions and location, based on the side-view default brain diagram.
#'
#' @format A tibble with 8 rows and 3 variables:
#' \describe{
#'   \item{x}{location on the x axis}
#'   \item{y}{location on the y axis}
#'   \item{region}{the region name}
#' }
"regions_side"

#' Regions Top default
#'
#' The default list of regions and location, based on the top-view default brain diagram.
#'
#' @format A tibble with 8 rows and 3 variables:
#' \describe{
#'   \item{x}{location on the x axis}
#'   \item{y}{location on the y axis}
#'   \item{region}{the region name}
#' }
"regions_top"

#' Regions Right default
#'
#' The default list of regions and location, based on the right-angle-view default brain diagram.
#'
#' @format A tibble with 8 rows and 3 variables:
#' \describe{
#'   \item{x}{location on the x axis}
#'   \item{y}{location on the y axis}
#'   \item{region}{the region name}
#' }
"regions_right"

#' Regions Left default
#'
#' The default list of regions and location, based on the left-angle-view default brain diagram.
#'
#' @format A tibble with 8 rows and 3 variables:
#' \describe{
#'   \item{x}{location on the x axis}
#'   \item{y}{location on the y axis}
#'   \item{region}{the region name}
#' }
"regions_left"