install_beast2_pkg: Install a BEAST2 package

View source: R/install_beast2_pkg.R

install_beast2_pkgR Documentation

Install a BEAST2 package

Description

Install a BEAST2 package. If the package is already installed, (see is_beast2_pkg_installed), this function stops.

Usage

install_beast2_pkg(
  name,
  beast2_folder = beastier::get_default_beast2_folder(),
  verbose = FALSE,
  has_internet = curl::has_internet()
)

Arguments

name

the package's name

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.

verbose

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

has_internet

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

Value

nothing. It does install the BEAST2 package

Note

Installing or uninstalling a BEAST2 package for a (singular) BEAST2 installation, does so for all BEAST2 installations

Author(s)

Richèl J.C. Bilderbeek

Examples

## Not run: 
  install_beast2_pkg("NS")

## End(Not run)

mauricer documentation built on Aug. 12, 2022, 9:06 a.m.