tests/testthat/test-rank_conversion.R

In bcgov/ranktrends: Summarise species data based on common conservation ranking systems

context("Test the rank conversion function")

test_that("test for NA data input", {
  expect_equal(suppressWarnings(ranks_to_numeric(NA_character_)), list(NA_real_))
  expect_warning(ranks_to_numeric(NA_character_),
                 "There is one or more NA values in your input dataset")
})


test_that("test the function works", {
  expect_is(ranks_to_numeric(c("S1", "SX", "S2S4")), 'list')
  expect_is(ranks_to_numeric(c("S1", "SX", "S2S4"), simplify = TRUE),
            'numeric')
  expect_equal(ranks_to_numeric(c("S1", "SX", "S2S4")),
               list(1, 0, c(2, 3, 4)))
})

test_that("the function works on all rank combinations", {
  test_ranks <- readRDS("test_rank_conversion.rds")
  expect_warning(
    num_ranks <- ranks_to_numeric(test_ranks$rank),
    "There is one or more NA values"
  )
  expect_equal(num_ranks, test_ranks$num_rank)
})

test_that("test the simplify function works", {
  test_ranks <- c("S1", "SX", "S2S4", "SH", "S2?")
  expect_equal(ranks_to_numeric(test_ranks, simplify = TRUE),
               c(1, 0, 3, 0.5, 2))
  expect_equal(ranks_to_numeric(test_ranks, simplify = TRUE,
                                round_fun = min), c(1, 0, 2, 0, 1))
  expect_equal(ranks_to_numeric(test_ranks, simplify = TRUE,
                                round_fun = max), c(1, 0, 4, 1, 3))
})

test_that("the keep function works", {
  test_ranks <- c("S1", "SX", "S2S4", "SH", "S2?", "S3B,S2N")
  expect_equal(ranks_to_numeric(test_ranks),
               list(1, 0, c(2,3,4), c(0,1), c(1,2,3), 3))
  expect_equal(ranks_to_numeric(test_ranks, keep = "N"),
               list(1, 0, c(2,3,4), c(0,1), c(1,2,3), 2))
})


test_that("test fails on non character input", {
  expect_error(ranks_to_numeric(1),"'ranks' should be a character vector")
  expect_error(ranks_to_numeric("S1", simplify = "text"),
               "simplify should be TRUE or FALSE")
  expect_error(ranks_to_numeric("S1", round_fun = "min"),
               "round_fun should be a function")
})