checkmate (version 1.9.3)

checkOS: Check the operating system

Description

Check the operating system

Usage

checkOS(os)
check_os(os)
assertOS(os, add = NULL, .var.name = NULL)
assert_os(os, add = NULL, .var.name = NULL)
testOS(os)
test_os(os)
expect_os(os, info = NULL, label = NULL)

Arguments

os

[character(1)] Check the operating system to be in a set with possible elements “windows”, “mac”, “linux” and “solaris”.

add

[AssertCollection] Collection to store assertion messages. See AssertCollection.

.var.name

[character(1)] Name of the checked object to print in assertions. Defaults to the heuristic implemented in vname.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Name of the checked object to print in messages. Defaults to the heuristic implemented in vname.

Value

Depending on the function prefix: If the check is successful, the functions assertOS/assert_os return x invisibly, whereas checkOS/check_os and testOS/test_os return TRUE. If the check is not successful, assertOS/assert_os throws an error message, testOS/test_os returns FALSE, and checkOS returns a string with the error message. The function expect_os always returns an expectation.

Examples

# NOT RUN {
testOS("linux")
# }