gives_beast2_warning: Determines if BEAST2 issues a warning when using the BEAST2...

Description Usage Arguments Value Author(s) See Also Examples

View source: R/gives_beast2_warning.R

Description

Determines if BEAST2 issues a warning when using the BEAST2 XML input file

Usage

1
2
3
4
5
gives_beast2_warning(
  filename,
  verbose = FALSE,
  beast2_path = beastier::get_default_beast2_path()
)

Arguments

filename

name of the BEAST2 XML input file

verbose

if TRUE, additional information is displayed, that is potentially useful in debugging

beast2_path

name of either a BEAST2 binary file (usually simply beast) or a BEAST2 jar file (usually has a .jar extension). Use get_default_beast2_bin_path to get the default BEAST binary file's path Use get_default_beast2_jar_path to get the default BEAST jar file's path

Value

TRUE if the file produces a BEAST2 warning, FALSE if not

Author(s)

Richèl J.C. Bilderbeek

See Also

Use is_beast2_input_file to check if a file is a valid BEAST2 input file. Use are_beast2_input_lines to check if the text (for example, as loaded from a file) to be valid BEAST2 input.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
if (is_beast2_installed() &&
  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")
  )
}

beastier documentation built on June 5, 2021, 5:06 p.m.