R/gives_beast2_warning.R

In richelbilderbeek/beastier: Call 'BEAST2'

#' Determines if BEAST2 issues a warning
#' when using the BEAST2 XML input file
#' @inheritParams default_params_doc
#' @param filename name of the BEAST2 XML input file
#' @return TRUE if the file produces a BEAST2 warning, FALSE if not
#' @author Richèl J.C. Bilderbeek
#' @seealso
#'   Use \code{\link{is_beast2_input_file}} to check if a file is a
#'   valid BEAST2 input file.
#'   Use \code{\link{are_beast2_input_lines}} to check if the text (for
#'   example, as loaded from a file) to be valid BEAST2 input.
#' @examples
#' if (is_beast2_installed() &&
#'   beautier::is_on_ci() &&
#'   rappdirs::app_dir()$os == "unix") {
#'
#'   # This file is OK for BEAST2, no warning, returns FALSE
#'   gives_beast2_warning(filename = get_beastier_path("2_4.xml"))
#'
#'   # BEAST2 will give a warning on this file, returns TRUE
#'   gives_beast2_warning(
#'     filename = get_beastier_path("beast2_warning.xml")
#'   )
#' }
#' @export
gives_beast2_warning <- function(
  filename,
  verbose = FALSE,
  beast2_path = get_default_beast2_path()
) {
  tryCatch({
      is_beast2_input_file(
        filename = filename,
        show_warnings = TRUE,
        verbose = verbose,
        beast2_path = beast2_path
      )
      FALSE
    },
    warning = function(msg) {
      return(TRUE)
    }
  )
}