R/read_beast2_trees.R

#' Extract a list of phylogenies from a BEAST2 posterior file
#' @param filename name of the BEAST2 posterior filename, usually ends with '.trees'
#' @return a list of phylogenies of type 'phylo'
#' @examples
#'   trees_file <- system.file(
#'     "extdata", "read_beast2_trees_example.trees", package = "RBeast"
#'   )
#'   testit::assert(file.exists(trees_file))
#'   posterior <- read_beast2_trees(trees_file)
#'   testit::assert(length(posterior) == 11)
#'   testit::assert(class(posterior[[1]]) == "phylo")
#' @export
#' @author Richel J.C. Bilderbeek
read_beast2_trees <- function(filename) {
  tracerer::parse_beast_trees(filename)
}
beast-dev/RBeast documentation built on May 12, 2019, 10:02 a.m.