R/data-docs.R

In melidosData: Load Data from the MeLiDos Field Study

#' MeLiDos site colors
#'
#' Named character vector of hex colors keyed by study site abbreviation.
#'
#' @format A named character vector.
#' @source MeLiDos study metadata.
"melidos_colors"

#' MeLiDos site time zones
#'
#' Named character vector of Olson time zone identifiers keyed by study site
#' abbreviation.
#'
#' @format A named character vector.
#' @source MeLiDos study metadata.
"melidos_tzs"

#' MeLiDos site countries
#'
#' Named character vector of country names keyed by study site abbreviation.
#'
#' @format A named character vector.
#' @source MeLiDos study metadata.
"melidos_countries"

#' MeLiDos site cities
#'
#' Named character vector of city names keyed by study site abbreviation.
#'
#' @format A named character vector.
#' @source MeLiDos study metadata.
"melidos_cities"

#' MeLiDos site coordinates
#'
#' Named list of latitude/longitude numeric pairs keyed by study site
#' abbreviation.
#'
#' @format A named list.
#' @source MeLiDos study metadata.
"melidos_coordinates"

#' Example REDCap chronotype data
#'
#' Example export containing chronotype questionnaire responses.
#'
#' @format A data frame.
#' @source `inst/ext/example_chronotype.csv`.
"REDCap_example_chronotype"

#' Example REDCap sleep diary data
#'
#' Example export containing sleep diary responses.
#'
#' @format A data frame.
#' @source `inst/ext/example_sleepdiary.csv`.
"REDCap_example_sleep"

#' Codebook strings to ignore, as it contains HTML formatting
#'
#' Codebook strings to ignore, as it contains HTML formatting
#'
#' @format A data frame.
"codebook_strings_to_ignore"