allow to filter state in read_metro_area

Author: rafapereirabr

r-package/R/read_metro_area.R

@@ -9,6 +9,9 @@
 #' reference system "SIRGAS2000" and CRS(4674).
 #'
 #' @param year Numeric. Year of the data in YYYY format. Defaults to `2018`.
+#' @param code_state The two-digit code of a state or a two-letter uppercase
+#'                   abbreviation (e.g. 33 or "RJ"). If `code_state="all"` (the
+#'                   default), the function downloads all states.
 #' @template simplified
 #' @template showProgress
 #'
@@ -22,8 +25,10 @@
 #'   m <- read_metro_area(2005)
 #'
 #'   m <- read_metro_area(2018)
-#'
-read_metro_area <- function(year=2018, simplified=TRUE, showProgress=TRUE){
+read_metro_area <- function(year = 2018,
+                            code_state = "all",
+                            simplified = TRUE,
+                            showProgress = TRUE){
 
   # Get metadata with data url addresses
   temp_meta <- select_metadata(geography="metropolitan_area", year=year, simplified=simplified)
@@ -37,5 +42,8 @@ read_metro_area <- function(year=2018, simplified=TRUE, showProgress=TRUE){
   # check if download failed
   if (is.null(temp_sf)) { return(invisible(NULL)) }
 
+  # filter state
+  temp_sf <- filter_state(temp_sf, code = code_state)
+
   return(temp_sf)
-}
+  }

r-package/man/read_metro_area.Rd

@@ -13,6 +13,24 @@ test_that("read_metro_area", {
   test_sf <- read_metro_area(year=2001)
   expect_true(is(test_sf, "sf"))
 
+  # filter state code
+  test_sf <- read_metro_area(code_state = 33)
+  expect_true(is(test_sf, "sf"))
+  expect_true(33 %in% unique(test_sf$code_state))
+
+  test_sf <- read_metro_area(code_state = c(33, 35))
+  expect_true(is(test_sf, "sf"))
+  expect_true(all(c(33, 35) %in% unique(test_sf$code_state)))
+
+  # filter state abbrev
+  test_sf <- read_metro_area(code_state = 'RJ')
+  expect_true(is(test_sf, "sf"))
+  expect_true('RJ' %in% unique(test_sf$abbrev_state))
+
+  test_sf <- read_metro_area(code_state = c('RJ', 'SP'))
+  expect_true(is(test_sf, "sf"))
+  expect_true(all(c('RJ', 'SP') %in% unique(test_sf$abbrev_state)))
+
 })
 
 
@@ -25,4 +43,9 @@ test_that("read_metro_area", {
   expect_error(read_metro_area(year="xxx"))
   expect_error(read_metro_area(year=NULL))
 
+  # filter state
+  expect_error(read_metro_area(code_state = c('RJ', 33)))
+  expect_error(read_metro_area(code_state = 'banana'))
+  expect_error(read_metro_area(code_state = 999999999))
+
 })