✨ Update downloading function for multiple years

NAMESPACE

@@ -15,6 +15,9 @@ export(post_process_sub)
 export(read_accident_data)
 export(reset_config)
 export(select_post_processor)
+importFrom(cli,cli_abort)
+importFrom(cli,cli_alert_success)
+importFrom(curl,multi_download)
 importFrom(lubridate,make_datetime)
 importFrom(readr,locale)
 importFrom(readr,read_csv)

R/download-accident-data.R

@@ -13,8 +13,9 @@
 #' @param type Type of data to download: one of "main", "sub", or "highway".
 #' @param download_dir A directory where downloaded file is to saved
 #' (default: `getwd()`).
-#' @param year Year the traffic accident data was recorded.
-#' Available from 2019 to 2023 (default: `2023`).
+#' @param years Years the traffic accident data were recorded.
+#' Available from 2019 to 2023. You can specify a single year or
+#' vector of years(default: `2023`).
 #' @return Path of the downloaded file (invisibly).
 #' @export
 #' @examples
@@ -23,33 +24,32 @@
 #' download_accident_data("sub", "download-dir-path", 2023)
 #' download_accident_data("highway", "download-dir-path", 2023)
 #' }
-download_accident_data <- function(type, download_dir = getwd(), year = 2023) {
+download_accident_data <- function(type, download_dir = getwd(), years = 2023) {
 
   # Mapping of type to actual file name part
   type_map <- c(main = "honhyo", sub = "hojuhyo", highway = "kosokuhyo")
 
   # Validation
   valid_types <- names(type_map)
   if (!type %in% valid_types) {
-    stop("Invalid type. Please specify one of: ",
-         paste(valid_types, collapse = ', '))
+    cli_abort("Invalid type. Please specify one of: {valid_types}.")
   }
 
-  if (year < 2019 || 2023 < year) {
-    stop("The year must be between 2019 and 2023.")
+  if (any(years < 2019 | years > 2023)) {
+    invalid_years <- years[years < 2019 | years > 2023]
+    cli_abort("The `years` must be between 2019 and 2023. Invalid year(s) provided: {invalid_years}.")
   }
 
   # Use string manipulation to create the URL
   page <- "https://www.npa.go.jp/publications/statistics/koutsuu/opendata"
-  url <- paste0(page, "/", year, "/", type_map[[type]], "_", year, ".csv")
+  urls <- paste0(page, "/", years, "/", type_map[[type]], "_", years, ".csv")
 
   # Create destination file path
-  destfile <- file.path(download_dir, basename(url))
+  destfiles <- file.path(download_dir, basename(urls))
 
   # Download
-  message("Downloading the file to: ", destfile)
-  downloaded_file_path <- download.file(url, destfile, quiet = TRUE)
-  message("Downloaded ", destfile, " successfly!")
+  downloaded_file_path <- multi_download(urls, destfiles)
+  cli_alert_success("Successfully downloaded {length(destfiles)} files to {download_dir}")
 
-  return(invisible(destfile))
+  return(invisible(destfiles))
 }

R/jpaccidents-package.R

@@ -2,6 +2,9 @@
 "_PACKAGE"
 
 ## usethis namespace: start
+#' @importFrom cli cli_abort
+#' @importFrom cli cli_alert_success
+#' @importFrom curl multi_download
 #' @importFrom lubridate make_datetime
 #' @importFrom readr locale
 #' @importFrom readr read_csv

tests/testthat/test-download-accident-data.R

@@ -1,8 +1,8 @@
 test_that("`download_accident_data` works with valid inputs", {
-  local_mocked_bindings(download.file = function(url, destfile, quiet) {
-    file.copy(mock_accident_data_path, destfile, overwrite = TRUE)
+  local_mocked_bindings(multi_download = function(urls, destfiles) {
+    file.copy(mock_accident_data_path, destfiles, overwrite = TRUE)
 
-    return(destfile)
+    return(destfiles)
   })
 
   # Test with "main" data type
@@ -30,13 +30,19 @@ test_that("`download_accident_data` works with valid inputs", {
 })
 
 test_that("`download_accident_data` handles invalid data types", {
-  expect_error(download_accident_data("invalid", temp_dir, 2022),
-               "Invalid type. Please specify one of: main, sub, highway")
+  expect_error(
+    download_accident_data("invalid", temp_dir, 2022),
+    "Invalid type. Please specify one of: main, sub, and highway."
+  )
 })
 
 test_that("`download_accident_data` handles invalid years", {
-  expect_error(download_accident_data("main", temp_dir, 2018),
-               "The year must be between 2019 and 2023.")
-  expect_error(download_accident_data("main", temp_dir, 2024),
-               "The year must be between 2019 and 2023.")
+  expect_error(
+    download_accident_data("main", temp_dir, 2018),
+    "The `years` must be between 2019 and 2023. Invalid year\\(s\\) provided: 2018."
+  )
+  expect_error(
+    download_accident_data("main", temp_dir, 2024),
+    "The `years` must be between 2019 and 2023. Invalid year\\(s\\) provided: 2024."
+  )
 })