nastyEdge <- structure(c(9, 12, 10, 13, 11, 10, 11, 13, 10, 13, 12, 9, 5, 10, 1, 2, 3, 13, 9, 4, 11, 7, 8, 6), .Dim = c(12, 2)) nasty <- structure(list(edge = nastyEdge, Nnode = 5L, tip.label = letters[1:8]), class = "phylo") expect_postorder <- function(edge) { parent <- edge[, 1] child <- edge[, 2] visited <- logical(max(parent)) root <- min(parent) for (i in seq_along(parent)) { visited[parent[i]] <- TRUE expect_true(child[i] < root || visited[child[i]]) } expect_equal(visited, c(logical(root - 1), !logical(max(parent) + 1 - root))) } test_that("RenumberTree() fails safely", { expect_error(RenumberTree(1:3, 1:4)) expect_error(RenumberTree(1:3, 1:4, 5:6)) expect_error(RenumberTree(1:4, 1:4, 5:6)) }) test_that("RenumberTree() handles polytomies", { tr <- ape::read.tree(text = "(a, (b, d, c));") edge <- tr$edge parent <- edge[, 1] child <- edge[, 2] ret <- RenumberTree(parent, child) expect_equal(c(5, 5, 6, 6, 6), ret[, 1]) expect_equal(c(1, 6, 2, 3, 4), ret[, 2]) edge <- structure(c(6L, 7L, 5L, 7L, 6L, 5L, 2L, 5L, 3L, 6L, 1L, 4L), .Dim = c(6L, 2L)) # Must be in preorder; i.e. each node in left subtree before each node in # right subtree for each subtree # # Also, nodes should be rotated such that the lowest tip in a subtree # is always encountered first. # # These rules ensure a unique representation for any tree. expectation <- structure(c(5L, 6L, 6L, 5L, 7L, 7L, 6L, 1L, 2L, 7L, 3L, 4L), .Dim = c(6L, 2L)) expect_equal(RenumberTree(edge[, 1], edge[, 2]), expectation) expect_equal(c(9, 10, 10, 11, 11, 11, 10, 12, 12, 13, 13, 9, 10, 1, 11, 2, 4, 7, 12, 3, 13, 5, 6, 8), as.integer(RenumberTree(nasty$edge[, 1], nasty$edge[, 2]))) }) test_that("RenumberTree() handles singles", { withSingles <- ape::read.tree(text = "(a, (b, (c), (((d), (e)))));") expect_equal(as.integer(Preorder(withSingles)$edge), c(6, 6, 7, 7, 8, 7, 9, 10, 11, 10, 12, 1, 7, 2, 8, 3, 9, 10, 11, 4, 12, 5)) }) test_that("Replacement reorder functions work correctly", { ## Tree tree <- ape::read.tree(text = "((((((1,2),3),4),5),6),(7,(8,(9,(10,(11,12))))));") expect_equal(ape::reorder.phylo(tree, "cladewise"), Cladewise(tree)) expect_equal(ape::reorder.phylo(tree, "pruningwise"), Pruningwise(tree)) post6 <- Postorder(BalancedTree(6))$edge expect_postorder(post6) parent6 <- post6[, 1] child6 <- post6[, 2] # Order of tip pairs is arbitrary\ expect_equal(1:2, sort(child6[parent6 == 9])) expect_equal(4:5, sort(child6[parent6 == 11])) expect_equal(c(6, 11), sort(child6[parent6 == 10])) expect_equal(c(3, 9), sort(child6[parent6 == 8])) expect_equal(c(8, 10), sort(child6[parent6 == 7])) star <- ape::read.tree(text = "(a, b, d, c);") edge <- RenumberTips(star, letters[1:4])$edge expect_equal(edge, RenumberTips(star, ape::read.tree(text = "(a, b, c, d);"))$edge) expect_equal(star$edge, RenumberTree(edge[, 1], edge[, 2])) expect_equal(list(star$edge[, 1], star$edge[, 2]), RenumberEdges(edge[, 1], edge[, 2])) }) test_that("RenumberTips() handles misspecification", { expect_error(RenumberTips(BalancedTree(8), paste0("t", 0:5)), "Missing in `tree`: t0.*Missing in `tipOrder`: t6, t7, t8") }) test_that("RenumberTips() works correctly", { abcd <- letters[1:4] dcba <- letters[4:1] bal7b <- BalancedTree(dcba) bal7f <- BalancedTree(abcd) pec7f <- PectinateTree(abcd) pec7b <- PectinateTree(dcba) l7 <- list("bal7b" = bal7b, "bal7f" = bal7f, "pec7f" = pec7f) f7 <- list(bal7f, bal7f, pec7f) b7 <- list(bal7b, bal7b, pec7b) mp7 <- structure(l7, class = "multiPhylo") expect_true(all.equal(f7, unname(RenumberTips(l7, abcd)))) expect_true(all.equal(b7, unname(RenumberTips(l7, dcba)))) expect_true(all.equal(structure(f7, class = "multiPhylo"), unname(RenumberTips(mp7, abcd)))) expect_true(all.equal(structure(b7, class = "multiPhylo"), unname(RenumberTips(mp7, dcba)))) expect_null(RenumberTips(NULL)) expect_equal(Preorder(RenumberTips(l7, c("extra tip", letters[1:5]))), Preorder(RenumberTips(l7, letters[1:4]))) expect_error(RenumberTips(l7, letters[2:5])) expect_equal( attr( RenumberTips(structure(b7, TipLabel = dcba, class = "multiPhylo"), abcd), "TipLabel" ), abcd ) }) test_that("postorder_order() works", { edg7 <- BalancedTree(7)$edge expect_postorder(edg7[postorder_order(edg7), ]) test2 <- edg7[c(1:4, 9, 8, 12, 11, 10, 7:5), ] expect_postorder(test2[postorder_order(test2), ]) nastyEdge <- structure(c(9, 12, 10, 13, 11, 10, 11, 13, 10, 13, 12, 9, 5, 10, 1, 2, 3, 13, 9, 4, 11, 7, 8, 6), .Dim = c(12, 2)) expect_postorder(nastyEdge[postorder_order(nastyEdge), ]) poly <- ape::read.tree(text = "((a, b, c), (d, (e, f)));")$edge expect_postorder(poly[postorder_order(poly), ]) star <- ape::read.tree(text = "(a, b, c, d, e, f);")$edge expect_postorder(star[postorder_order(star), ]) expect_error(PostorderOrder(1:5), "edge matrix of a `phylo` obj") expect_error(PostorderOrder(matrix(1, 3, 3)), "edge matrix of a `phylo` obj") expect_equal(PostorderOrder(BalancedTree(4)), rev(seq_len(nrow(BalancedTree(4)$edge)))) expect_equal(PostorderOrder(Postorder(BalancedTree(4))), seq_len(nrow(BalancedTree(4)$edge))) expect_postorder(nastyEdge[PostorderOrder(nastyEdge), ]) expect_postorder(nastyEdge[PostorderOrder(nasty), ]) }) test_that("Reorder methods work correctly", { bal7 <- BalancedTree(7) bal7$edge.length <- 1:12 * 10 attr(bal7, "order") <- NULL pec7 <- PectinateTree(7) list7 <- list(bal7, pec7) stt <- SingleTaxonTree(1) bad <- bal7 bad$Nnode <- 100 attr(bad, "order") <- NULL mp7 <- structure(list7, class = "multiPhylo") Test <- function(Method, ..., testEdges = TRUE) { expect_identical(Method(bal7, ...), Method(list7, ...)[[1]]) expect_identical(Method(pec7, ...), Method(mp7, ...)[[2]]) expect_true(all.equal(Method(stt), stt)) expect_identical(Method(bal7), Method(Method(bal7))) expect_equal(Method(bal7), Method(Preorder(Postorder(Cladewise(Pruningwise(bal7)))))) if (testEdges) expect_equal(Method(bal7)$edge, Method(bal7$edge)) expect_error(Method(10)) expect_error(Method(1:2)) expect_error(Method(matrix("one"))) expect_null(Method(NULL)) } Test(ApePostorder, testEdges = FALSE) expect_error(ApePostorder(bad)) Test(Postorder, testEdges = FALSE) # Different order if edge lengths present expect_postorder(Postorder(nastyEdge)) Test(Cladewise) expect_error(Cladewise(bad)) Test(Preorder) Test(TntOrder, testEdges = FALSE) Test(Pruningwise, testEdges = FALSE) expect_error(Pruningwise(bad)) }) test_that("Preorder() gives identical output", { tree1 <- BalancedTree(1:9) numbers <- c("One", "Two", "Three", "Four", "Five", "Six", "Seven", "Eight", "Nine") tree2 <- BalancedTree(numbers[1:9]) # Force pre-order with NEW tip labels tree2 <- Preorder(Postorder(RenumberTips(tree2, sort(numbers)))) tree2$tip.label <- as.character(match(sort(numbers), numbers)) expect_true(all.equal(tree1, tree2)) expect_false(identical(tree1, tree2)) # Now preorder after renumbering. # Renumbering should drop the previous preorder attribute. pre2 <- Preorder(RenumberTips(tree2, as.character(1:9))) expect_equal(tree1, pre2) expect_identical(tree1, pre2) }) test_that("Reorder methods retain edge weights", { bal7 <- BalancedTree(7) bal7$edge.length <- 1:12 * 10 attr(bal7, "order") <- NULL expect_equal(Preorder(bal7)[["edge.length"]], bal7$edge.) expect_equal(Preorder(Cladewise(bal7))[["edge.length"]], bal7$edge.) expect_equal(Preorder(Postorder(bal7))[["edge.length"]], bal7$edge.) }) test_that("Reorder methods retain node labels", { bal7 <- BalancedTree(7) startLabels <- paste("Node", 8:13) bal7[["node.label"]] <- startLabels attr(bal7, "order") <- NULL if (interactive()) { plot(bal7, show.node.label = TRUE, xpd = NA) } expect_equal(Preorder(bal7)[["node.label"]], startLabels) expect_equal(Cladewise(bal7)[["node.label"]], startLabels) expect_equal(Preorder(Cladewise(bal7))[["node.label"]], startLabels) expect_equal(Postorder(bal7)[["node.label"]], startLabels) expect_equal(Preorder(Postorder(bal7))[["node.label"]], startLabels) }) test_that("Malformed trees don't cause crashes", { treeDoubleNode <- read.tree(text = "((((((1,2)),3),4),5),6);") treePolytomy <- read.tree(text = "((((1,2,3),4),5),6);") treeDoublyPoly <- read.tree(text = "(((((1,2,3)),4),5),6);") nasty <- structure(list(edge = structure( c(9, 12, 10, 13, 11, 10, 11, 13, 10, 13, 12, 9, 5, 10, 1, 2, 3, 13, 9, 4, 11, 7, 8, 6), .Dim = c(12, 2)), Nnode = 5L, tip.label = letters[1:8]), class = "phylo") # Danger: Do not plot! reordered <- Preorder(treeDoubleNode)$edge expect_equal(11L, dim(reordered)[1]) expect_equal(5L, sum(tabulate(reordered[, 1]) == 2L)) postordered <- Postorder(treeDoubleNode)$edge expect_equal(11L, dim(postordered)[1]) expect_equal(5L, sum(tabulate(postordered[, 1]) == 2L)) reordered <- Preorder(treePolytomy)$edge expect_equal(9L, dim(reordered)[1]) expect_equal(c(2L, 2L, 2L, 3L), as.integer(table(reordered[, 1]))) reordered <- Postorder(treePolytomy)$edge expect_equal(9L, dim(reordered)[1]) expect_equal(c(2L, 2L, 2L, 3L), as.integer(table(reordered[, 1]))) reordered <- Preorder(treeDoublyPoly)$edge expect_equal(10L, dim(reordered)[1]) expect_equal(c(2L, 2L, 2L, 1L, 3L), as.integer(table(reordered[, 1]))) reordered <- Postorder(treeDoublyPoly)$edge expect_equal(10L, dim(reordered)[1]) expect_equal(c(2L, 2L, 2L, 1L, 3L), as.integer(table(reordered[, 1]))) #C <- 0 #plot(Preorder(nasty)); nodelabels(c(12, 10, 13, 11, 9) - C); tiplabels(1:8 - C) #edgelabels(c(2, 3, 6, 4, 8, 10, 9, 5, 7, 1, 12, 11) - C) reordered <- Preorder(nasty)$edge expect_equal(12L, dim(reordered)[1]) # Nodes renumbered expect_equal(c(2L, 3L, 3L, 2L, 2L), tabulate(reordered[, 1])[9:13]) reordered <- Postorder(nasty)$edge expect_equal(12L, dim(reordered)[1]) expect_postorder(reordered) })