get_beast2_pkg_names: Get all BEAST2 package names

Description Usage Arguments Value Author(s) Examples

View source: R/get_beast2_pkg_names.R

Description

List all BEAST2 packages that are available and installed. Will stop if there is no internet connection

Usage

1
2
3
4
5
get_beast2_pkg_names(
  beast2_folder = beastier::get_default_beast2_folder(),
  has_internet = curl::has_internet(),
  verbose = FALSE
)

Arguments

beast2_folder

the folder where the BEAST2 is installed. Note that this is not the folder where the BEAST2 executable is installed: the BEAST2 executable is in a subfolder. Use get_default_beast2_folder to get the default BEAST2 folder. Use get_default_beast2_bin_path to get the full path to the default BEAST2 executable. Use get_default_beast2_jar_path to get the full path to the default BEAST2 jar file.

has_internet

boolean to indicate if the user has access to the internet. By default, this value equals the result of curl::has_internet

verbose

set to TRUE for extra output, as can be used in debugging

Value

a data frame with columns

  1. name package name, for example, codebdmm

  2. installed_version the installed version, for example, 2.6.2. installed_version will be NA if the package is not installed

  3. latest_version version number of the latest version, for example, 2.6.3

  4. dependencies packages the package depends on, for example BEASTLabs, GEO_SPHERE. dependencies will be empty if there are no dependencies

  5. description description of the package, for example Nested sampling for model selection and posterior inference

Author(s)

Richèl J.C. Bilderbeek

Examples

1
2
3
if (is_beast2_installed() && curl::has_internet()) {
  get_beast2_pkg_names()
}

mauricer documentation built on Sept. 8, 2021, 5:06 p.m.