R/sibling.R

In tidytree: A Tidy Tool for Phylogenetic Tree Data Manipulation

##' @method sibling tbl_tree
##' @export
sibling.tbl_tree <- function(.data, .node, ...) {
    valid.tbl_tree(.data)

    p <- parent(.data, .node)
    if (nrow(p) == 0) # if root node, return empty tibble
        return(p)
    child(.data, p$node) %>% filter(.data$node != .node)
}

##' @method sibling phylo
##' @export
sibling.phylo <- function(.data, .node, ...) {
    root <- rootnode(.data)
    if (.node == root) {
        return(NA)
    }

    pp <- parent(.data, .node)
    cc <- child(.data, pp)
    sib <- cc[cc != .node]
    return(sib)
}