If I used loadGubbins() followed by drop.tip() to remove the (undated) reference, the $unrec element does not have the corresponding edge removed and becomes out of order, which is potentially a problem with useRec = T.
I'm not sure how common an issue this is, but may be worth noting in the docs?
Also, I think the following tweak to drop.tip() fixes this, but I'm not sure whether this is worth adding to the package:
drop.tip.useRec = function (phy, tip, trim.internal = TRUE, subtree = FALSE, root.edge = 0,
rooted = is.rooted(phy), collapse.singles = TRUE, interactive = FALSE)
{
if (!inherits(phy, "phylo"))
stop("object \"phy\" is not of class \"phylo\"")
Ntip <- length(phy$tip.label)
if (interactive) {
cat("Left-click close to the tips you want to drop; right-click when finished...\n")
xy <- locator()
nToDrop <- length(xy$x)
tip <- integer(nToDrop)
lastPP <- get("last_plot.phylo", envir = .PlotPhyloEnv)
for (i in 1:nToDrop) {
d <- sqrt((xy$x[i] - lastPP$xx)^2 + (xy$y[i] - lastPP$yy)^2)
tip[i] <- which.min(d)
}
}
else {
if (is.character(tip))
tip <- which(phy$tip.label %in% tip)
}
out.of.range <- tip > Ntip
if (any(out.of.range)) {
warning("some tip numbers were larger than the number of tips: they were ignored")
tip <- tip[!out.of.range]
}
if (!length(tip))
return(phy)
if (length(tip) == Ntip) {
if (Nnode(phy) < 3 || trim.internal) {
warning("drop all tips of the tree: returning NULL")
return(NULL)
}
}
wbl <- !is.null(phy$edge.length)
wbl.unrec <- !is.null(phy$unrec)
if (length(tip) == Ntip - 1 && trim.internal) {
i <- which(phy$edge[, 2] == (1:Ntip)[-tip])
res <- list(edge = matrix(2:1, 1, 2), tip.label = phy$tip.label[phy$edge[i,
2]], Nnode = 1L)
class(res) <- "phylo"
if (wbl)
res$edge.length <- phy$edge.length[i]
if (wbl.unrec)
res$unrec <- phy$unrec[i]
if (!is.null(phy$node.label))
res$node.label <- phy$node.label[phy$edge[i, 1] -
Ntip]
return(res)
}
if (!rooted && subtree) {
phy <- root(phy, (1:Ntip)[-tip][1])
root.edge <- 0
}
phy <- reorder(phy)
NEWROOT <- ROOT <- Ntip + 1
Nnode <- phy$Nnode
Nedge <- dim(phy$edge)[1]
if (subtree) {
trim.internal <- TRUE
tr <- reorder(phy, "postorder")
N <- .C(node_depth, as.integer(Ntip), as.integer(tr$edge[,
1]), as.integer(tr$edge[, 2]), as.integer(Nedge),
double(Ntip + Nnode), 1L)[[5]]
}
edge1 <- phy$edge[, 1]
edge2 <- phy$edge[, 2]
keep <- !logical(Nedge)
keep[match(tip, edge2)] <- FALSE
if (trim.internal) {
ints <- edge2 > Ntip
repeat {
sel <- !(edge2 %in% edge1[keep]) & ints & keep
if (!sum(sel))
break
keep[sel] <- FALSE
}
if (subtree) {
subt <- edge1 %in% edge1[keep] & edge1 %in% edge1[!keep]
keep[subt] <- TRUE
}
if (root.edge && wbl) {
degree <- tabulate(edge1[keep])
if (degree[ROOT] == 1) {
j <- integer(0)
repeat {
i <- which(edge1 == NEWROOT & keep)
j <- c(i, j)
NEWROOT <- edge2[i]
degree <- tabulate(edge1[keep])
if (degree[NEWROOT] > 1)
break
}
keep[j] <- FALSE
if (length(j) > root.edge)
j <- 1:root.edge
NewRootEdge <- sum(phy$edge.length[j])
if (length(j) < root.edge && !is.null(phy$root.edge))
NewRootEdge <- NewRootEdge + phy$root.edge
phy$root.edge <- NewRootEdge
}
}
}
if (!root.edge)
phy$root.edge <- NULL
phy$edge <- phy$edge[keep, ]
if (wbl)
phy$edge.length <- phy$edge.length[keep]
if (wbl.unrec)
phy$unrec <- phy$unrec[keep]
TERMS <- !(phy$edge[, 2] %in% phy$edge[, 1])
oldNo.ofNewTips <- phy$edge[TERMS, 2]
if (subtree) {
i <- which(tip %in% oldNo.ofNewTips)
if (length(i)) {
phy$tip.label[tip[i]] <- "[1_tip]"
tip <- tip[-i]
}
}
n <- length(oldNo.ofNewTips)
phy$edge[TERMS, 2] <- rank(phy$edge[TERMS, 2])
if (length(tip))
phy$tip.label <- phy$tip.label[-tip]
if (subtree || !trim.internal) {
node2tip <- oldNo.ofNewTips[oldNo.ofNewTips > Ntip]
new.tip.label <- if (!length(node2tip)) {
character(0)
}
else if (subtree) {
paste("[", N[node2tip], "_tips]", sep = "")
}
else {
if (is.null(phy$node.label))
rep("NA", length(node2tip))
else phy$node.label[node2tip - Ntip]
}
phy$tip.label <- c(phy$tip.label, new.tip.label)
}
phy$Nnode <- dim(phy$edge)[1] - n + 1L
newNb <- integer(Ntip + Nnode)
newNb[NEWROOT] <- n + 1L
sndcol <- phy$edge[, 2] > n
newNb[sort(phy$edge[sndcol, 2])] <- (n + 2):(n + phy$Nnode)
phy$edge[sndcol, 2] <- newNb[phy$edge[sndcol, 2]]
phy$edge[, 1] <- newNb[phy$edge[, 1]]
storage.mode(phy$edge) <- "integer"
if (!is.null(phy$node.label))
phy$node.label <- phy$node.label[which(newNb > 0) - Ntip]
if (collapse.singles)
phy <- collapse.singles.useRec(phy)
phy
}
collapse.singles.useRec <- function (tree, root.edge = FALSE)
{
n <- length(tree$tip.label)
tree <- reorder(tree)
e1 <- tree$edge[, 1]
e2 <- tree$edge[, 2]
tab <- tabulate(e1)
if (all(tab[-c(1:n)] > 1))
return(tree)
if (is.null(tree$edge.length)) {
root.edge <- FALSE
wbl <- FALSE
}
else {
wbl <- TRUE
el <- tree$edge.length
}
if (is.null(tree$unrec)) {
wbl.unrec <- FALSE
}
else {
wbl.unrec <- TRUE
unrec <- tree$unrec
}
if (root.edge)
ROOTEDGE <- 0
ROOT <- n + 1L
while (tab[ROOT] == 1) {
i <- which(e1 == ROOT)
ROOT <- e2[i]
if (wbl) {
if (root.edge)
ROOTEDGE <- ROOTEDGE + el[i]
el <- el[-i]
unrec <- unrec[-i]
}
e1 <- e1[-i]
e2 <- e2[-i]
}
singles <- which(tabulate(e1) == 1)
if (length(singles) > 0) {
ii <- sort(match(singles, e1), decreasing = TRUE)
jj <- match(e1[ii], e2)
for (i in 1:length(singles)) {
e2[jj[i]] <- e2[ii[i]]
if (wbl.unrec)
unrec[jj[i]] <- (el[jj[i]]*unrec[jj[i]] + el[ii[i]]*unrec[ii[i]])/(el[jj[i]] + el[ii[i]]) # correct?
if (wbl)
el[jj[i]] <- el[jj[i]] + el[ii[i]]
}
e1 <- e1[-ii]
e2 <- e2[-ii]
if (wbl)
el <- el[-ii]
if (wbl.unrec)
unrec <- unrec[-ii]
}
Nnode <- length(e1) - n + 1L
oldnodes <- unique(e1)
if (!is.null(tree$node.label))
tree$node.label <- tree$node.label[oldnodes - n]
newNb <- integer(max(oldnodes))
newNb[ROOT] <- n + 1L
sndcol <- e2 > n
e2[sndcol] <- newNb[e2[sndcol]] <- n + 2:Nnode
e1 <- newNb[e1]
tree$edge <- cbind(e1, e2, deparse.level = 0)
tree$Nnode <- Nnode
if (wbl) {
if (root.edge)
tree$root.edge <- ROOTEDGE
tree$edge.length <- el
tree$unrec <- unrec
}
tree
}
If I used
loadGubbins()
followed bydrop.tip()
to remove the (undated) reference, the$unrec
element does not have the corresponding edge removed and becomes out of order, which is potentially a problem withuseRec = T
.I'm not sure how common an issue this is, but may be worth noting in the docs? Also, I think the following tweak to
drop.tip()
fixes this, but I'm not sure whether this is worth adding to the package: