download_data Function

names(formals(download_hms))
#>  [1] "data_format"       "date"              "directory_to_save"
#>  [4] "acknowledgement"   "download"          "remove_command"   
#>  [7] "unzip"             "remove_zip"        "show_progress"    
#> [10] "hash"              "max_tries"         "rate_limit"

dates <- c("2023-12-28", "2024-01-02")
data_format <- "Shapefile"
data_directory <- "./download_example/"
acknowledgement <- TRUE
unzip <- TRUE # inflate (unzip) downloaded zip files
remove_zip <- FALSE # retain downloaded zip files

download_data(
  dataset_name = "hms",
  date = dates,
  data_format = data_format,
  directory_to_save = data_directory,
  acknowledgement = acknowledgement,
  unzip = unzip,
  remove_zip = remove_zip
)

list.files(data_directory)

download_hms
#> function (data_format = "Shapefile", date = c("2018-01-01", "2018-01-01"), 
#>     directory_to_save = NULL, acknowledgement = FALSE, download = TRUE, 
#>     remove_command = FALSE, unzip = TRUE, remove_zip = FALSE, 
#>     show_progress = TRUE, hash = FALSE, max_tries = 20, rate_limit = 2) 
#> {
#>     amadeus::download_permit(acknowledgement = acknowledgement)
#>     amadeus::check_for_null_parameters(mget(ls()))
#>     if (length(date) == 1) {
#>         date <- c(date, date)
#>     }
#>     stopifnot(length(date) == 2)
#>     date <- date[order(as.Date(date))]
#>     if (as.Date(date[1]) < as.Date("2005-08-05")) {
#>         stop("NOAA HMS wildfire smoke data begins at August 05, 2005.")
#>     }
#>     directory_original <- amadeus::download_sanitize_path(directory_to_save)
#>     directories <- amadeus::download_setup_dir(directory_original, 
#>         zip = TRUE)
#>     directory_to_download <- directories[1]
#>     directory_to_save <- directories[2]
#>     if (!isTRUE(download)) {
#>         warning("Setting download=FALSE is deprecated.\n", call. = FALSE)
#>     }
#>     if (remove_command != FALSE) {
#>         warning("Parameter 'remove_command' is deprecated and ignored.\n", 
#>             call. = FALSE)
#>     }
#>     if (unzip == FALSE && remove_zip == TRUE) {
#>         stop(paste0("Arguments unzip = FALSE and remove_zip = TRUE are not ", 
#>             "acceptable together. Please change one.\n"))
#>     }
#>     date_sequence <- amadeus::generate_date_sequence(date[1], 
#>         date[2], sub_hyphen = TRUE)
#>     base <- "https://satepsanone.nesdis.noaa.gov/pub/FIRE/web/HMS/Smoke_Polygons/"
#>     all_urls <- character()
#>     all_destfiles <- character()
#>     for (f in seq_along(date_sequence)) {
#>         year <- substr(date_sequence[f], 1, 4)
#>         month <- substr(date_sequence[f], 5, 6)
#>         if (tolower(data_format) == "shapefile") {
#>             data_format <- "Shapefile"
#>             suffix <- ".zip"
#>             directory_to_cat <- directory_to_download
#>         }
#>         else if (tolower(data_format) == "kml") {
#>             data_format <- "KML"
#>             suffix <- ".kml"
#>             directory_to_cat <- directory_to_save
#>         }
#>         url <- paste0(base, data_format, "/", year, "/", month, 
#>             "/hms_smoke", date_sequence[f], suffix)
#>         if (f == 1) {
#>             if (!amadeus::check_url_status(url)) {
#>                 stop(paste0("Invalid date returns HTTP code 404. ", 
#>                   "Check `date` parameter.\n"))
#>             }
#>         }
#>         destfile <- paste0(directory_to_cat, "hms_smoke_", data_format, 
#>             "_", date_sequence[f], suffix)
#>         if (amadeus::check_destfile(destfile)) {
#>             all_urls <- c(all_urls, url)
#>             all_destfiles <- c(all_destfiles, destfile)
#>         }
#>     }
#>     if (!isTRUE(download)) {
#>         message(sprintf("Skipping download. Found %d files available for download.\n", 
#>             length(all_urls)))
#>         return(invisible(list(urls = all_urls, destfiles = all_destfiles, 
#>             n_files = length(all_urls))))
#>     }
#>     if (length(all_urls) == 0L) {
#>         message("All requested HMS files already exist. Nothing to download.\n")
#>         return(invisible(list(success = 0, failed = 0, skipped = length(date_sequence))))
#>     }
#>     download_result <- amadeus::download_run_method(urls = all_urls, 
#>         destfiles = all_destfiles, token = NULL, show_progress = show_progress, 
#>         max_tries = max_tries, rate_limit = rate_limit)
#>     if (data_format == "KML") {
#>         unlink(directory_to_download, recursive = TRUE)
#>         message("KML files cannot be unzipped.\n")
#>         if (hash) {
#>             return(amadeus::download_hash(hash = TRUE, directory_to_save))
#>         }
#>         else {
#>             return(invisible(download_result))
#>         }
#>     }
#>     for (d in seq_along(all_destfiles)) {
#>         amadeus::download_unzip(file_name = all_destfiles[d], 
#>             directory_to_unzip = directory_to_save, unzip = unzip)
#>     }
#>     amadeus::download_remove_zips(remove = remove_zip, download_name = all_destfiles)
#>     if (hash) {
#>         return(amadeus::download_hash(hash = TRUE, directory_to_save))
#>     }
#>     else {
#>         return(invisible(download_result))
#>     }
#> }
#> <bytecode: 0x16d071b8>
#> <environment: namespace:amadeus>