tests/testthat/test_dep_get_index.R

In deprivateR: Calculating and Analyzing Measures of Deprivation in the United States

# test errors ------------------------------------------------

test_that("missing geography triggers error", {
  expect_error(
    dep_get_index(index = "ndi_m", year = 2020, survey = "acs5"),
    "geography.*must be provided"
  )
})

test_that("invalid geography triggers error", {

  expect_error(
    dep_get_index(geography = "hamlet", index = "ndi_m", year = 2020, survey = "acs5"),
    "Invalid.*geography"
  )
})

test_that("missing index triggers error", {
  expect_error(
    dep_get_index(geography = "county", year = 2020, survey = "acs5"),
    "index.*must be provided"
  )
})

test_that("invalid index triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ham", year = 2020, survey = "acs5"),
    "Invalid.*index"
  )
})

test_that("missing year triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", survey = "acs5"),
    "year.*must be provided"
  )
})

test_that("invalid year triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2000, survey = "acs5"),
    "year.*invalid"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = "ham", survey = "acs5"),
    "year.*invalid"
  )
})

test_that("svi14/svi20 year constraint triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "svi14", year = 2010, survey = "acs5"),
    "not valid for 2014 or 2020 SVI specifications"
  )
  expect_error(
    dep_get_index(geography = "county", index = "svi20", year = 2011, survey = "acs5"),
    "not valid for 2014 or 2020 SVI specifications"
  )
})

test_that("svi20s year constraint triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "svi20s", year = 2018, survey = "acs5"),
    "not valid for the 2020 SVI specification with the alternate single parent"
  )
})

test_that("invalid survey triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "ham"),
    "survey.*not valid"
  )
})

test_that("discontinued acs3 survey triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs3"),
    "acs3.*discontinued"
  )
})

test_that("non-logical return_percentiles triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  return_percentiles = "yes"),
    "logical scalar.*return_percentiles"
  )
})

test_that("non-logical keep_subscales triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  keep_subscales = "yes"),
    "logical scalar.*keep_subscales"
  )
})

test_that("non-logical keep_components triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  keep_components = "yes"),
    "logical scalar.*keep_components"
  )
})

test_that("territory in state argument triggers error", {
  # Abbreviation input (converted to FIPS by validate_state before the check)
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "PR"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "AS"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "GU"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "MP"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "VI"),
    "Territories cannot be specified"
  )

  # Direct FIPS input
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "72"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "60"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "66"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "69"),
    "Territories cannot be specified"
  )
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5", state = "78"),
    "Territories cannot be specified"
  )
})

test_that("state and county both specified triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  state = "MO", county = "29510"),
    "state.*or.*county.*not both"
  )
})

test_that("non-logical puerto_rico triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  puerto_rico = "yes"),
    "logical scalar.*puerto_rico"
  )
})

test_that("invalid output triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  output = "ham"),
    "output.*not valid"
  )
})

test_that("tidy output with keep_components triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  output = "tidy", keep_components = TRUE),
    "Tidy output.*keep_components.*FALSE"
  )
})

test_that("non-logical zcta_cb triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  zcta_cb = "yes"),
    "logical scalar.*zcta_cb"
  )
})

test_that("non-logical shift_geo triggers error", {
  expect_error(
    dep_get_index(geography = "county", index = "ndi_m", year = 2020, survey = "acs5",
                  shift_geo = "yes"),
    "logical scalar.*shift_geo"
  )
})