closes #31

ipeaGIT · Jul 16, 2023 · 59f88e4 · 59f88e4
1 parent 9d51036
commit 59f88e4
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 15 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,10 @@
 # flightsbr v0.3.0999 dev
 
+* Major changes:
+  * The functions `read_flights()` and `read_airport_movements()` now have a new parameter `cache`, which indicates whether the function should read cached data downloaded previously. Defaults to `TRUE`. Closed #31.
+
 * Minor changes:
   * All functions now return numeric columns with `numeric` class. Closed #32.
-  * The function `read_flights()` has a new parameter `cache`, which indicates whether the function should read cached data downloaded previously. Defaults to `TRUE`. Closed #31.
 
 * Bug fixes:
   * Fixed bug when unzipping files for `read_flights()` function in Unix systems. 

diff --git a/R/read_airport_movements.R b/R/read_airport_movements.R
@@ -10,6 +10,7 @@
 #'
 #' @template date
 #' @template showProgress
+#' @template cache
 #'
 #' @return A `"data.table" "data.frame"` object. All columns are returned with
 #'         `class` of type `"character"`.
@@ -21,7 +22,9 @@
 #'
 #' amov2020 <- read_airport_movements(date = 2020)
 #'}}
-read_airport_movements <- function(date = 202001, showProgress = TRUE){
+read_airport_movements <- function(date = 202001,
+                                   showProgress = TRUE ,
+                                   cache = TRUE){
 
   ### check inputs
   if( ! is.logical(showProgress) ){ stop(paste0("Argument 'showProgress' must be either 'TRUE' or 'FALSE.")) }
@@ -48,7 +51,9 @@ read_airport_movements <- function(date = 202001, showProgress = TRUE){
     file_url <- get_airport_movements_url(year=y, month=m)
 
     # download and read data
-    dt <- download_airport_movement_data(file_url, showProgress = showProgress)
+    dt <- download_airport_movement_data(file_url,
+                                         showProgress,
+                                         cache)
 
     # check if download failed
     if (is.null(dt)) { return(invisible(NULL)) } # nocov
@@ -85,7 +90,9 @@ read_airport_movements <- function(date = 202001, showProgress = TRUE){
                                     file_url <- get_airport_movements_url(year=y, month=m)
 
                                     # download and read data
-                                    temp_dt <- download_airport_movement_data(file_url, showProgress = FALSE)
+                                    temp_dt <- download_airport_movement_data(file_url,
+                                                                              showProgress = FALSE,
+                                                                              cache)
 
                                     # check if download failed
                                     if (is.null(temp_dt)) { return(invisible(NULL)) }

diff --git a/R/utils.R b/R/utils.R
@@ -376,7 +376,9 @@ get_airfares_url <- function(dom, year, month) { # nocov start
 #'                         dest_file = tempfile(fileext = ".zip")
 #'                        )
 #'}}
-download_flightsbr_file <- function(file_url, showProgress=showProgress, dest_file = temp_local_file){
+download_flightsbr_file <- function(file_url = parent.frame()$file_url,
+                                    showProgress = parent.frame()$showProgress,
+                                    dest_file = temp_local_file){
 
   # download data
   try(
@@ -423,7 +425,7 @@ download_flightsbr_file <- function(file_url, showProgress=showProgress, dest_fi
 #' # download data
 #' a <- download_flights_data(file_url=file_url, showProgress=TRUE, select=NULL)
 #'}}
-download_flights_data <- function(file_url,
+download_flights_data <- function(file_url = parent.frame()$file_url,
                                   showProgress = parent.frame()$showProgress,
                                   select = parent.frame()$select,
                                   cache = parent.frame()$cache){ # nocov start
@@ -492,7 +494,9 @@ download_flights_data <- function(file_url,
 #' # download data
 #' a <- download_airfares_data(file_url=file_url, showProgress=TRUE, select=NULL)
 #'}}
-download_airfares_data <- function(file_url, showProgress=showProgress, select=select){ # nocov start
+download_airfares_data <- function(file_url = parent.frame()$file_url,
+                                   showProgress = parent.frame()$showProgress,
+                                   select = parent.frame()$select){ # nocov start
 
   # create temp local file
   file_name <- basename(file_url)
@@ -588,6 +592,7 @@ get_airport_movements_url <- function(year, month) { # nocov start
 #'
 #' @param file_url String. A url passed from \code{\link{get_flights_url}}.
 #' @param showProgress Logical, passed from \code{\link{read_flights}}
+#' @param cache Logical, passed from \code{\link{read_flights}}
 #'
 #' @return A `"data.table" "data.frame"` object
 #'
@@ -599,14 +604,21 @@ get_airport_movements_url <- function(year, month) { # nocov start
 #' # download data
 #' a <- download_airport_movement_data(file_url=file_url, showProgress=TRUE)
 #'}}
-download_airport_movement_data <- function(file_url, showProgress=showProgress){ # nocov start
+download_airport_movement_data <- function(file_url = parent.frame()$file_url,
+                                           showProgress = parent.frame()$showProgress,
+                                           cache = parent.frame()$cache){ # nocov start
 
   # # create temp local file
   file_name <- basename(file_url)
   temp_local_file <- paste0(tempdir(),"/",file_name)
 
+  # use cached files or not
+  if (cache==FALSE & file.exists(temp_local_file)) {
+    unlink(temp_local_file, recursive = T)
+  }
+
   # check if file has not been downloaded already. If not, download it
-  if (!file.exists(temp_local_file) | file.info(temp_local_file)$size == 0) {
+  if (cache==FALSE | !file.exists(temp_local_file) | file.info(temp_local_file)$size == 0) {
 
     # download data
     download_flightsbr_file(file_url=file_url, showProgress=showProgress, dest_file = temp_local_file)

diff --git a/man/download_airfares_data.Rd b/man/download_airfares_data.Rd
diff --git a/man/download_airport_movement_data.Rd b/man/download_airport_movement_data.Rd
diff --git a/man/download_flights_data.Rd b/man/download_flights_data.Rd
diff --git a/man/download_flightsbr_file.Rd b/man/download_flightsbr_file.Rd
diff --git a/man/read_airport_movements.Rd b/man/read_airport_movements.Rd
diff --git a/tests/testthat/test_read_airport_movements.R b/tests/testthat/test_read_airport_movements.R
@@ -19,6 +19,19 @@ test_that("read_airport_movements", {
   # all months in a year
   test2 <- read_airport_movements(date=2022, showProgress = FALSE)
   testthat::expect_true(is(test2, "data.table"))
+
+
+  # check whether cache argument is working
+  time_first <- system.time(
+    f201506 <- read_airport_movements(date = 202210))
+
+  time_cache_true <- system.time(
+    f201506 <- read_airport_movements(date = 202210, cache = TRUE))
+
+  time_cache_false <- system.time(
+    f201506 <- read_airport_movements(date = 202210, cache = FALSE))
+
+  testthat::expect_true( time_cache_true[['elapsed']] < time_cache_false[['elapsed']] )
  })