tests/testthat/test-treespatial-scan.R

test_that("treespatial_scan validates inputs", {
  tree <- data.frame(node_id = c(1, 2, 3), parent_id = c(NA, 1, 1))
  expect_error(
    treespatial_scan(cases = 1:3, population = c(100, 100),
                     region_id = 1:3, x = 1:3, y = 1:3,
                     node_id = c(2, 2, 3), tree = tree),
    "must have the same length"
  )
})

test_that("treespatial_scan returns expected class and structure", {
  ex <- generate_example_data(n_regions = 16, seed = 1)
  res <- treespatial_scan(
    cases = ex$cases, population = ex$population,
    region_id = ex$region_id, x = ex$x, y = ex$y,
    node_id = ex$node_id, tree = ex$tree,
    nsim = 29, seed = 42
  )
  expect_s3_class(res, "treespatial_scan")
  expect_true(all(c("most_likely_cluster", "pvalue", "nsim") %in% names(res)))
  expect_gte(res$most_likely_cluster$llr, 0)
  expect_gte(res$pvalue, 0); expect_lte(res$pvalue, 1)
})

test_that("treespatial_scan detects injected cluster", {
  ex <- generate_example_data(n_regions = 25, cluster_regions = 1:5,
                              cluster_leaves = c(3, 4),
                              rr = 4.0, Cg = 300L, seed = 77)
  res <- treespatial_scan(
    cases = ex$cases, population = ex$population,
    region_id = ex$region_id, x = ex$x, y = ex$y,
    node_id = ex$node_id, tree = ex$tree,
    nsim = 199, seed = 77
  )
  detected <- res$most_likely_cluster$region_ids
  injected <- ex$true_cluster$region_ids
  overlap <- length(intersect(detected, injected)) / length(injected)
  expect_gte(overlap, 0.5)
})

test_that("treespatial_scan accepts tree_node_id/tree_parent_id form", {
  ex <- generate_example_data(n_regions = 16, seed = 1)
  res1 <- treespatial_scan(
    cases = ex$cases, population = ex$population,
    region_id = ex$region_id, x = ex$x, y = ex$y,
    node_id = ex$node_id, tree = ex$tree,
    nsim = 19, seed = 1
  )
  res2 <- treespatial_scan(
    cases = ex$cases, population = ex$population,
    region_id = ex$region_id, x = ex$x, y = ex$y,
    node_id = ex$node_id,
    tree_node_id = ex$tree$node_id,
    tree_parent_id = ex$tree$parent_id,
    nsim = 19, seed = 1
  )
  expect_equal(res1$most_likely_cluster$llr,
               res2$most_likely_cluster$llr)
})

Try the treeSS package in your browser

Any scripts or data that you put into this service are public.

treeSS documentation built on May 16, 2026, 1:08 a.m.