sffs: Simple Features For Science

#' Sagital view of an adult human brain.
#'
#' Ideal for visualizing gene expression data from the Brainspan developmental
#' transcriptome or GTEx.
#'
#' @format A simple feature collection with 16 features and 7 fields
#' \describe{
#'   \item{id}{short name of brain region}
#'   \item{lab_x}{x coordinate of manual region label}
#'   \item{lab_y}{y coordinate of manual region label}
#'   \item{line_x}{x coordinate of line pointing to manual region label}
#'   \item{line_y}{y coordinate of line pointing to manual region label}
#'   \item{line_xend}{x coordinate of line pointing to region}
#'   \item{line_yend}{y coordinate of line pointing to  region}
#'   \item{geometry}{the sf shape corresponding to the region}
#' }
#'
#' @source \href{https://www.gnu.org/licenses/gpl-3.0.en.html}{GPL-3.0} by \url{https://github.com/ethanbahl/cerebroViz}
#'
#' @concept brain
#' @concept human
#'
#' @family brains
#'
#' @examples
#' sf_brain <- sffs::sf_brain_outer
#' plot(sf_brain['id'], key.length = 1)
"sf_brain_outer"

#' Sagital view of an adult human brain.
#'
#' Ideal for visualizing gene expression data from the Brainspan developmental
#' transcriptome or GTEx.
#'
#' @format A simple feature collection with 16 features and 7 fields
#' \describe{
#'   \item{id}{short name of brain region}
#'   \item{lab_x}{x coordinate of manual region label}
#'   \item{lab_y}{y coordinate of manual region label}
#'   \item{line_x}{x coordinate of line pointing to manual region label}
#'   \item{line_y}{y coordinate of line pointing to manual region label}
#'   \item{line_xend}{x coordinate of line pointing to region}
#'   \item{line_yend}{y coordinate of line pointing to  region}
#'   \item{geometry}{the sf shape corresponding to the region}
#' }
#' @source \href{https://www.gnu.org/licenses/gpl-3.0.en.html}{GPL-3.0} by \url{https://github.com/ethanbahl/cerebroViz}
#'
#' @concept brain
#' @concept human
#'
#' @family brains
#'
#' @examples
#' sf_brain <- sf_brain_slice
#' plot(sf_brain["id"], key.length = 1)
"sf_brain_slice"


#' Super-regions of an adult human brain.
#'
#' A remix of \code{\link{sf_brain_outer}}. Ideal for visualizing gene expression
#' data from the Brainspan developmental transcriptome or GTEx.
#'
#' @format A simple feature collection with 8 features and 1 field
#' \describe{
#'   \item{id}{short name of brain region}
#'   \item{geometry}{the sf shape corresponding to the region}
#' }
#' @source \href{https://www.gnu.org/licenses/gpl-3.0.en.html}{GPL-3.0} by \url{https://github.com/ethanbahl/cerebroViz}
#'
#' @concept remix
#' @concept brain
#' @concept human
#'
#' @family brains
#'
#' @examples
#' sf_brain <- sf_brain_outer_super_region
#' plot(sf_brain, key.length = 1)
"sf_brain_outer_super_region"

#' Example data for use with \code{\link{sf_brain_outer}} and \code{\link{sf_brain_slice}}
#'
#' @format A data.frame with 21 columns
#' \describe{
#'   \item{id}{short name of brain region}
#'   \item{`12 pcw`}{expression at 12 pcw }
#'   \item{`16 pcw`}{expression at 16 pcw }
#'   \item{`21 pcw`}{expression at 21 pcw }
#'   \item{`24 pcw`}{expression at 24 pcw }
#'   \item{`37 pcw`}{expression at 37 pcw }
#'   \item{`4 mos`}{expression at 4 mos }
#'   \item{`1 yrs`}{expression at 1 yrs }
#'   \item{`2 yrs`}{expression at 2 yrs }
#'   \item{`3 yrs`}{expression at 3 yrs }
#'   \item{`8 yrs`}{expression at 8 yrs }
#'   \item{`11 yrs`}{expression at 11 yrs }
#'   \item{`13 yrs`}{expression at 13 yrs }
#'   \item{`18 yrs`}{expression at 18 yrs }
#'   \item{`19 yrs`}{expression at 19 yrs }
#'   \item{`21 yrs`}{expression at 21 yrs }
#'   \item{`23 yrs`}{expression at 23 yrs }
#'   \item{`30 yrs`}{expression at 30 yrs }
#'   \item{`36 yrs`}{expression at 36 yrs }
#'   \item{`37 yrs`}{expression at 37 yrs }
#'   \item{`40 yrs`}{expression at 40 yrs }
#' }
#' @source \url{https://github.com/ethanbahl/cerebroViz}
#'
#' @concept brain
#' @concept example_data
#'
#' @examples
#' sf_brain <- sf_brain_outer
#' sf_brain_data <- brain_data
#' sf_brain %>%
#'     dplyr::left_join(sf_brain_data) %>%
#'     dplyr::select(id, dplyr::ends_with('pcw')) %>%
#'     plot()
"brain_data"