R/get_tree_priors_n_distrs.R

In ropensci/beautier: 'BEAUti' from R

#' Get the number of distributions a tree prior has
#' @inheritParams default_params_doc
#' @return the number of distributions a tree prior has
#' @author Richèl J.C. Bilderbeek
#' @examples
#' check_empty_beautier_folder()
#'
#' # Three distrubutions
#' get_tree_priors_n_distrs(
#'   list(
#'     create_bd_tree_prior(), # has two distributions
#'     create_ccp_tree_prior() # has one distribution
#'   )
#' )
#'
#' check_empty_beautier_folder()
#' @export
get_tree_priors_n_distrs <- function(
  tree_priors
) {
  if (!are_tree_priors(tree_priors)) {
    stop("'tree_priors' must be a list of one or more tree priors")
  }
  n <- 0
  for (tree_prior in tree_priors) {
    check_true(is_tree_prior(tree_prior))
    n <- n + get_tree_prior_n_distrs(tree_prior)
  }
  n
}