R/vms_setup_directory.R

#' @title Create directories
#'
#' @description The function creates three directories in the current working
#' directory: data-raw, data-tidy and data-product. Also seeds in example
#' VMS data set upon request (requires internet connection).
#'
#' @param example Boolean, if TRUE (defaul) will copy the
#' \url{ftp://ftp.hafro.is/pub/reiknid/einar/vms/iceland_vms.csv} into the
#' data-raw directory.
#'
#' @return NULL
#' @export
#'
vms_setup_directory <- function(example = TRUE) {

  if(!dir.exists("data-raw")) dir.create("data-raw")
  if(!dir.exists("data-tidy")) dir.create("data-tidy")
  if(!dir.exists("data-products")) dir.create("data-products")

  if(example) {
    tmp <- utils::read.csv("ftp://ftp.hafro.is/pub/reiknid/einar/vms/iceland_vms.csv")
    utils::write.csv(tmp, file = paste0("data-raw", "/iceland_vms.csv"), row.names = FALSE)
  }

}
fishvice/ghsllr documentation built on May 24, 2019, 1:36 a.m.