tests/testthat/test_filtering.R

In AltfunsMA/cptools: Tools for Consumer Pyramids and other Indian Data Wrangling

context("Filtering tests")

# Open a file to send messages to
f <- "messages.Rout"
zz <- file(f, open = "wt")
# Divert messages to that file
sink(zz)

# despite cptools no longer requiring sf package; these tests are based on sf
# objects and many tidyverse internals need new methods supplied by sf to work
# properly. Loading it here is the best workaround I have come up with so far.
library(sf) 

# Load samples
sf_sample <- readRDS("~/Projects/cptools/tests/testthat/sample_sf.rds") %>% 
  dplyr::mutate(ST_NAME = dplyr::case_when(
    ST_NAME == "Andhra Pradesh" & AC_NO < 50 ~ 'Delhi',
    ST_NAME == "Andhra Pradesh" & dplyr::between(AC_NO, 50, 100) ~ 'Daman and Diu',
    ST_NAME == "Andhra Pradesh" & dplyr::between(AC_NO, 100, 150) ~ 'Chandigarh',
    ST_NAME == "Andhra Pradesh" & dplyr::between(AC_NO, 150, 200) ~ 'Manipur',
    TRUE ~ as.character(ST_NAME))
    )

sink()
close(zz)
# file.remove(f)

total_rows <- nrow(sf_sample)

nvals <- sum(is.na(sf_sample$ST_NAME))

n <- total_rows - nvals
                   
test_that("Warnings about NAs appear, and that NAs are indeed removed", {
  expect_warning(exclude_states(sf_sample, "not_in_cpw1"), " contains NA values.")
  expect_equal(suppressWarnings(nrow(exclude_states(sf_sample, "not_in_cpw1"))), n-50)
})
  
sf_sample <- dplyr::filter(sf_sample, !is.na(ST_NAME))

n <- sf_sample %>% 
  dplyr::filter(!is.na(ST_NAME)) %>% 
  nrow()

test_that("Null or empty vector in ... returns an empty df with a warning",
          {expect_warning(include_states(sf_sample, character()))
          expect_warning(include_states(sf_sample, NULL))
          expect_equal(nrow(suppressWarnings(exclude_states(sf_sample, NULL))), 0)
            })

test_that("No ... arguments returns early error", {
  expect_error(include_states(sf_sample), "arguments are required")
  expect_error(exclude_states(sf_sample), "arguments are required")
})

test_that("Warnings appear for non-character objects named in ...",
          expect_warning(exclude_states(sf_sample, mtcars, "Guj", "small_rich"), "non-character")
          )

test_that("`fixed` and `ignore_case` arguments are passed on correctly", {
          expect_equal(nrow(include_states(sf_sample, "Guj", fixed = TRUE)), 0)
          expect_equal(nrow(exclude_states(sf_sample, "guj", ignore_case = FALSE)), 0)
          })

test_that("Filters and by implication state selection works", {
  expect_error(exclude_states(mtcars, "tamil"), "No column")
  expect_equal(nrow(exclude_states(sf_sample, no_vidhan)), n-101)
  expect_equal(nrow(exclude_states(sf_sample, "not_in_cpw1")), n-50)
  expect_equal(nrow(include_states(sf_sample, Gujarat)), (178))
  expect_equal(nrow(include_states(sf_sample, "no_vidhan")), 101)
  expect_equal(nrow(include_states(sf_sample, c("no_vidhan", "not_in_cpw1"))), 151)
})


test_that("Different formatting of ... input yields the same practical output", {
  expect_equal(exclude_states(sf_sample, "small_rich"),
               exclude_states(sf_sample, small_rich))
  expect_equal(exclude_states(sf_sample, "Guj"),
               exclude_states(sf_sample, guj))
  expect_equal(suppressWarnings(exclude_states(sf_sample, mtcars, "Guj", "small_rich")),
               suppressWarnings(exclude_states(sf_sample, mtcars, Guj, small_rich)))

})