tests/testthat/test-queen.R

In chessboard: Create Network Connections Based on Chess Moves

# Data for tests ----

sites <- expand.grid("transect" = 1:5, 
                     "quadrat"  = 1:5)

nodes <- create_node_labels(data     = sites, 
                             transect = "transect", 
                             quadrat  = "quadrat")

sites_qu <- expand.grid("transect" = 3, 
                        "quadrat"  = 1:5)

nodes_qu <- create_node_labels(data     = sites_qu, 
                                transect = "transect", 
                                quadrat  = "quadrat")

sites_tr <- expand.grid("transect" = 1:5, 
                        "quadrat"  = 3)

nodes_tr <- create_node_labels(data     = sites_tr, 
                                transect = "transect", 
                                quadrat  = "quadrat")

# Tests for errors ----

test_that("queen() - Tests for errors", {
  
  expect_error(queen(),
               paste0("Argument 'nodes' is required (output of the function ", 
                      "create_node_labels())"),
               fixed = TRUE)
  
  expect_error(queen(nodes_qu),
               paste0("The queen movement is not designed to work through ", 
                      "quadrats only. Please use pawn() instead."),
               fixed = TRUE)
  
  expect_error(queen(nodes_tr),
               paste0("The queen movement is not designed to work through ", 
                      "transects only. Please use fool() instead."),
               fixed = TRUE)
})


# Tests for success ----

test_that("queen() - Tests for success (2D network)", {
  
  expect_silent({
    neighbors <- queen(nodes,
                       focus    = "3-3",
                       degree   = 1,
                       directed = TRUE,
                       reverse  = FALSE, 
                       self     = FALSE)
  })
  
  expect_equal(class(neighbors), "data.frame")
  expect_equal(ncol(neighbors), 4L)
  expect_equal(nrow(neighbors), 5L)
  expect_equal(neighbors[ , "node"], c("2-3", "2-4", "3-4", "4-3", "4-4"))
  
  
  expect_silent({
    neighbors <- queen(nodes,
                       focus    = "3-3",
                       degree   = 2,
                       directed = TRUE,
                       reverse  = FALSE, 
                       self     = FALSE)
  })
  
  expect_equal(class(neighbors), "data.frame")
  expect_equal(ncol(neighbors), 4L)
  expect_equal(nrow(neighbors), 10L)
  expect_equal(neighbors[ , "node"], c("1-3", "1-5", "2-3", "2-4", "3-4", "3-5",
                                       "4-3", "4-4", "5-3", "5-5"))
  
  
  expect_silent({
    neighbors <- queen(nodes,
                       focus    = "3-3",
                       degree   = 1,
                       directed = TRUE,
                       reverse  = TRUE, 
                       self     = FALSE)
  })
  
  expect_equal(class(neighbors), "data.frame")
  expect_equal(ncol(neighbors), 4L)
  expect_equal(nrow(neighbors), 5L)
  expect_equal(neighbors[ , "node"], c("2-2", "2-3", "3-2", "4-2", "4-3"))
  
  
  expect_silent({
    neighbors <- queen(nodes,
                       focus    = "3-3",
                       degree   = 1,
                       directed = FALSE,
                       reverse  = FALSE, 
                       self     = FALSE)
  })
  
  expect_equal(class(neighbors), "data.frame")
  expect_equal(ncol(neighbors), 4L)
  expect_equal(nrow(neighbors), 8L)
  expect_equal(neighbors[ , "node"], c("2-2", "2-3", "2-4", "3-2", "3-4", "4-2",
                                       "4-3", "4-4"))
  
  
  expect_silent({
    neighbors <- queen(nodes,
                       focus    = "3-3",
                       degree   = 1,
                       directed = FALSE,
                       reverse  = FALSE, 
                       self     = TRUE)
  })
  
  expect_equal(class(neighbors), "data.frame")
  expect_equal(ncol(neighbors), 4L)
  expect_equal(nrow(neighbors), 9L)
  expect_equal(neighbors[ , "node"], c("2-2", "2-3", "2-4", "3-2", "3-3", "3-4",
                                       "4-2", "4-3", "4-4"))
})