R/load_door_data.R

Defines functions load_door_data

Documented in load_door_data

#' load_door_data
#' 
#' load all DoOR.data
#' 
#' 
#' @param nointeraction if set to TRUE does not promt security message.
#'   Necessary e.g. for building vignettes during CHECK.
#'   
#' @return attaches all DoOR data to the main workspace
#' @aliases loadData load_door_data
#' @author Daniel Münch <\email{daniel.muench@uni-konstanz.de}>
#' @examples
#' # load all data to current workspace
#' \dontrun{
#' load_door_data()
#' }
#' 
#' # it is also possible to load individual data sets using data().
#' data(Or22a)
#' @export load_door_data
load_door_data <- function(nointeraction = FALSE) {
  if (nointeraction == FALSE) {
    answer <- ""
    while (answer != "n" & answer != "y") {
      answer <-
        readline(
          "This will load all DoOR data into the current environment, possibly 
          overwriting existing data. Continue? (y/n)? "
        )
      if (answer == "y")
        break()
      if (answer == "n")
        stop("aborted loading data")
    }
  }
  
  
  all.data <- utils::data(package = "DoOR.data")
  utils::data(list = all.data$results[, 3], package = "DoOR.data")
}
Dahaniel/DoOR.data documentation built on Feb. 14, 2022, 4:51 p.m.