tests/testthat/test-cw.R

In etam4260/hudr: A R interface for accessing HUD (US Department of Housing and Urban Development) APIs

# Should allow user to provide county name/state names/abbreviations. All string
# inputs that can be numeric inputs can be supplied as a numeric input.
test_that("hud_cw() for All Types", {
  skip_if_no_key()
  # For these tests, none of  the Crosswalk queries should throw an error.
  # Need to also check for if these queries result a satiable result; need
  # to add least have 1 row or more in data frame returned.


  # Testing county to zip cross_walk. Assuming this to be the most popular.
  county_zip <- hud_cw(type = 7, query = "22031",
                       year = c("2010", "2011"),
                       quarter = c("1", "2", "3", "4"))

  expect_equal(length(county_zip), 8)

  expect_true(nrow(county_zip) == 90)

  # Try all counties in MD
  county_zip_two <- hud_cw(type = 7,
                           query = substr(hud_state_counties("md")$fips_code, 1, 5),
                           year = c("2010"), quarter = c("1"))

  expect_equal(length(county_zip_two), 8)

  expect_true(nrow(county_zip_two) == 635)




  # Lets try a ZIP code in Alabama for now for 1 -> 5 as well as 11.
  zip_tract <- hud_cw(type = 1, query = "35213",
                      year = c("2010", "2011"), quarter = c("1"))
  expect_equal(length(zip_tract), 8)

  expect_true(nrow(zip_tract) == 18)

  zip_county <- hud_cw(type = "2", query = "35213",
                       year = c("2016", "2020"), quarter = c("2"))
  expect_equal(length(zip_county), 8)

  expect_true(nrow(zip_county) == 2)

  zip_cbsa <- hud_cw(type = 3, query = 35213,
                     year = c("2012", "2011"), quarter = c("3"))
  expect_equal(length(zip_cbsa), 8)

  expect_true(nrow(zip_cbsa) == 2)

  zip_cbsadiv <- hud_cw(type = 4, query = "22031",
                        year = c("2017", "2019"), quarter = c("4"))
  expect_equal(length(zip_cbsadiv), 8)

  expect_true(nrow(zip_cbsadiv) == 2)

  zip_cd <- hud_cw(type = "5", query = "35213",
                   year = c(2011, "2012"), quarter = c("1", "2"))
  expect_equal(length(zip_cd), 8)

  expect_true(nrow(zip_cd) == 12)

  tract_zip <- hud_cw(type = 6, query = "48201223100",
                      year = c("2017", "2010"),
                      quarter = c("1", "2", "3"))
  expect_equal(length(tract_zip), 8)

  expect_true(nrow(tract_zip) == 12)


  # A core based Statistical Area to zip crosswalk.
  # CBSA defines Micropolitan and Metropolitan
  cbsa_zip <- hud_cw(type = 8, query = "10140",
                     year = c("2010", "2011"), quarter = c("2", "1"))
  expect_equal(length(cbsa_zip), 8)

  expect_true(nrow(cbsa_zip) == 84)

  # Must be a core base statistical area division code which apply to
  # metropolitan areas.
  cbsadiv_zip <- hud_cw(type = 9, query = "10380",
                        year = c("2017"), quarter = c("4"))
  expect_equal(length(cbsadiv_zip), 8)

  expect_true(nrow(cbsadiv_zip) == 15)

  cd_zip <- hud_cw(type = 10, query = "2202",
                   year = c("2010", "2011"), quarter = c("4", "3"))
  expect_equal(length(cd_zip), 8)

  expect_true(nrow(cd_zip) == 145)

  # Testing ZIP CODE _> COUNTYSUB
  zip_countysub <- hud_cw(type = 11, query = "35213",
                          year = c("2019", "2020"), quarter = c("2", "3"))
  expect_equal(length(zip_countysub), 8)

  expect_true(nrow(zip_countysub) == 4)

  # User might not provide a "set" of years or quarters, so should make sure to
  # check that Sometimes the API might not provide data because out of range
  # years. Also testing Countysub _> ZIP
  # Not sure if R has a package for all these types of GEOIDs

  countysub_zip <- hud_cw(type = 12, query = "4606720300 ",
                          year = c("2019", "2019", "2019"),
                          quarter = c("4", "4"))
  expect_equal(length(countysub_zip), 8)

  expect_true(nrow(countysub_zip) == 1)
})


test_that("hud_cw() for Different Years", {
  skip_if_no_key()
  # Error when years are in the future
  expect_error(hud_cw(type = 7, query = "22031",
                      year = c("2010", "2011", "2024"),
                      quarter = c("1", "2", "3", "4")))
})


test_that("hud_cw() for Different Quarters", {
  skip_if_no_key()
  # Error when quarters are not from 1 to 4
  expect_error(hud_cw(type = 7, query = "22031",
                      year = c("2010", "2011"),
                      quarter = c("1", "2", "3", "4", "5")))
})


test_that("hud_cw() for Invalid Queries", {
  skip_if_no_key()
  expect_error(hud_cw(type = 7, query = "22031241231",
                      year = c("2010", "2011"),
                      quarter = c("1", "2", "3", "4")))

  # No zip code named 99999
  expect_warning(hud_cw(type = 1, query = "99999",
                        year = c("2010", "2011"),
                        quarter = c("1", "1", "2", "3", "4")))
})


test_that("hud_cw() for Nonnumeric Inputs", {
  # Character arguments that aren"t numbers in any of them. Throws errors.
  skip_if_no_key()
  expect_error(hud_cw(type = "dwqji", query = "22031",
                      year = c("2010", "2011"),
                      quarter = c("1", "2", "3", "4")))

  expect_error(hud_cw(type = "7", query = "22031ada",
                      year = c("2010", "2011"),
                      quarter = c("1", "2", "3", "4")))

  expect_error(hud_cw(type = "7", query = "22031",
                      year = c("2010", "2011adaadda"),
                      quarter = c("1", "2ada", "3", "4")))

  expect_error(hud_cw(type = 7, query = "22031",
                      year = c("2010", "2011"),
                      quarter = c("1", "2as", "3", "4")))
})