R/rand_absent_tippr.R

In treestartr: Generate Starting Trees for Combined Molecular, Morphological and Stratigraphic Data

#' Random addition of taxa
#' @description Add tips not on existing tree to the tree at random, if they do
#' not have congeners on the tree.
#' @param tree Starting tree; object of type phylo
#' @param absent_list Vector of taxa in the total dataset that are not on the
#' tree
#' @param echo_subtrees Boolean; Print newick subtree with missing taxa added to screen. Default FALSE.
#' @param echo_revbayes Boolean; Print clade constraints with missing taxa added to screen, formatted for RevBayes fossilized birth-death analysis. Default FALSE.
#' @return tree Phylo object containing the starting tree,
#'          and all tips that were added.
#' @importFrom utils tail
#' @importFrom phytools getParent
#' @importFrom ape extract.clade
#' @importFrom ape write.tree
#' @examples
#' new_tree <- rand_absent_tippr(tree, absent_list)
#' @export
#'

rand_absent_tippr <- function(tree, absent_list, echo_subtrees = NULL,
                              echo_revbayes = NULL){
#Check that tree is of object phylo
  if (!inherits(tree, "phylo")){
    stop("tree must be of class 'phylo'")
  }
  if (is.null(echo_subtrees)){
  } else{
    message("Echoing Subtrees to Screen")
  }
  if (is.null(echo_revbayes)){
  } else{
    message("Echoing RevBayes-formatted Subtrees to Screen")
  }
  lost_df <- get_lost(absent_list, tree)

  for (row in seq_len(nrow(lost_df))) {
    tip <- as.character(lost_df[[row, "full_name"]])
    message("Adding tips at random node: ", tip)
    nodel <- tree$edge[, 2]
    if(exists("num") == TRUE){
      parent <- phytools::getParent(tree, num)
      nodel <- nodel[! nodel == num]
    }
    num <- sample(nodel, 1)
    if (is.null(num)){
      num <- num + 1
    }
    print(num)
    tree <- ape::multi2di(tree)
    tree <- suppressWarnings(phytools::bind.tip(tree, tip, where = num, edge.length=.05))
    if (!is.null(echo_revbayes)){
      parent <- phytools::getParent(tree, num)
      sub_list <- ape::extract.clade(tree, parent)
      quote_vec <-paste0('"', sub_list$tip.label, '"')
      q_vec <-paste0(quote_vec[-length(quote_vec)], ',')
      q_final <- append(q_vec, tail(quote_vec, n=1))
      cat("clade(", q_final, ")", '\n')
    }
    if (!is.null(echo_subtrees)){
      parent <- phytools::getParent(tree, num)
      sub_list <- ape::extract.clade(tree, parent)
      cat("Subtree:", ape::write.tree(ape::multi2di(sub_list)), '\n')
    }
  }
  return(tree)
}