R/has_twinning.R

In richelbilderbeek/pirouette: Create a Bayesian Posterior from a Phylogeny

#' Determine if these \code{pir_params} use twinning
#' @inheritParams default_params_doc
#' @return TRUE if the pir_params uses twinnning
#' @examples
#' if (beautier::is_on_ci()) {
#'
#'   pir_params <- create_test_pir_params()
#'   # Returns FALSE
#'   has_twinning(pir_params)
#'
#'   pir_params <- create_test_pir_params(
#'     twinning_params = create_twinning_params()
#'   )
#'   # Returns TRUE
#'   has_twinning(pir_params)
#'
#' }
#' @export
has_twinning <- function(pir_params) {
  pirouette::check_pir_params(pir_params)
  !beautier::is_one_na(pir_params$twinning_params)
}