Check Rust Backend Requirements

check_mdrb() returns a boolean indicating whether a suitable version of the metabodecon Rust backend mdrb is currently installed.

check_mdrb_deps() returns a list with detailed information about the installation status of mdrb and its dependencies.

Usage

check_mdrb(stop_on_fail = FALSE)

check_mdrb_deps()

Arguments

stop_on_fail

If TRUE, an error is thrown if the check fails, providing instructions on how to install or upgrade mdrb.

Value

check_mdrb() returns TRUE if a suitable version of mdrb is installed, else FALSE.

check_mdrb_deps() returns a data.frame with the following columns:

• check: description of the checked dependency as a string

• passed: boolean indicating whether the check passed

• comment: free text string describing the check result

The rownames of the dataframe are: r, rtools, cargo and rustc and correspond to the checked dependencies.

Example:

check_mdrb_deps()

##                check passed                                      comment
## r           R >= 4.2   TRUE                             Current: R 4.4.2
## rtools  Rtools exist   TRUE     Tested with: pkgbuild::has_build_tools()
## cargo  cargo >= 1.78   TRUE Current: cargo 1.84.1 (66221abde 2024-11-19)
## rustc  rustc >= 1.78   TRUE Current: rustc 1.84.1 (e71f9a9a9 2025-01-27)

Author

2024-2025 Tobias Schmidt: initial version.

Examples

check_mdrb()
#> [1] TRUE
check_mdrb_deps()
#>                check passed                                      comment
#> r           R >= 4.2   TRUE                             Current: R 4.5.0
#> rtools  Rtools exist   TRUE        Testcall: pkgbuild::has_build_tools()
#> cargo  cargo >= 1.78   TRUE Current: cargo 1.86.0 (adf9b6ad1 2025-02-28)
#> rustc  rustc >= 1.78   TRUE Current: rustc 1.86.0 (05f9846f8 2025-03-31)