R/get_nltt_error_fun.R

Defines functions get_nltt_error_fun

Documented in get_nltt_error_fun

#' Get an error function that uses the nLTT statistic
#' @return a numeric vector of errors
#' @author Richèl J.C. Bilderbeek
#' @examples
#'
#' error_fun <- get_nltt_error_fun()
#'
#' phylogeny <- ape::read.tree(text = "((A:1.5, B:1.5):1.5, C:3.0);")
#'
#' tree_1 <- ape::read.tree(text = "((A:1.0, B:1.0):2.0, C:3.0);")
#' tree_2 <- ape::read.tree(text = "((A:2.0, B:2.0):1.0, C:3.0);")
#' trees <- c(tree_1, tree_2)
#'
#' lowest_error <- error_fun(phylogeny, c(phylogeny))
#' @export
get_nltt_error_fun <- function() {
  nLTT::nltts_diff
}
richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.