assert_bbi_version: Check that bbi satisfies a version constraint

In metrumresearchgroup/rbabylon: R package for bbi

Check that bbi satisfies a version constraint

Description

Check that bbi satisfies a version constraint

Usage

assert_bbi_version(
  .bbi_exe_path = getOption("bbr.bbi_exe_path"),
  .min_version = getOption("bbr.bbi_min_version"),
  .function = NULL
)

test_bbi_version(
  .bbi_exe_path = getOption("bbr.bbi_exe_path"),
  .min_version = getOption("bbr.bbi_min_version")
)

Arguments

.bbi_exe_path	Path to bbi executable
.min_version	The minimum allowed version. Defaults to getOption("bbr.bbi_min_version").
.function	The relevant function that is version-constrained. If not NULL, notifies user in error message.

Value

• assert_bbi_version() returns the value of .bbi_exe_path.

• test_bbi_version() returns TRUE if the installed bbi satisfies the constraint and FALSE otherwise.

metrumresearchgroup/rbabylon documentation built on April 21, 2024, 3:26 a.m.