tests/testthat/test_checkArg.R

In BBmisc: Miscellaneous Helper Functions for B. Bischl

context("argument check")

test_that("checkArg", {
  f = function(x) checkArg(x, cl="integer", len=1)
  expect_silent(f(1L))
  expect_error(f(1))
  expect_error(f(1:2))
  f = function(x) checkArg(x, cl="integer", min.len=2)
  expect_silent(f(1:2))
  expect_error(f(1L))
  f = function(x) checkArg(x, cl="integer", max.len=2)
  expect_silent(f(1:2))
  expect_error(f(1:3))
  f = function(x) checkArg(x, cl="integer", len=2, na.ok=FALSE)
  expect_silent(f(1:2))
  expect_error(f(c(3L, NA)))
  f = function(x) checkArg(x, cl="numeric", lower=2)
  expect_silent(f(4:6))
  expect_error(f(1:3))
  f = function(x) checkArg(x, cl="numeric", upper=2)
  expect_silent(f(1))
  expect_error(f(3), "less than or equal 2")
  f = function(x) checkArg(x, cl="numeric", lower=1, upper=2)
  expect_silent({f(1); f(1.5); f(2)})
  expect_error(f(0), "greater than or equal 1")
  expect_error(f(3), "less than or equal 2")

  f = function(x) checkArg(x, cl="numeric", lower=1, upper=5)
  expect_silent(f(1:5))
  expect_error(f(0:5), "greater than or equal 1")
  expect_error(f(1:6), "less than or equal 5")

  f = function(x) checkArg(x, formals=c("foo", "bar"))
  expect_silent(f(function(foo, bar) 1))
  expect_silent(f(function(foo, bar, bla) 1))
  expect_error(f(1), "must be of class function not: numeric")
  expect_error(f(function(blubb) 1), "must have first formal args")
  expect_error(f(function(foo) 1), "must have first formal args")

  expect_silent(checkArg(1, "vector"))
  expect_silent(checkArg(1L, "vector"))
  expect_silent(checkArg(TRUE, "vector"))
  expect_silent(checkArg("a", "vector"))
  expect_silent(checkArg(list(), "vector"))
  expect_silent(checkArg(list(1), "vector"))
})


test_that("checkArg with choices", {
  f = function(x) checkArg(x, choices=c("a", "b"))
  f("a")
  f("b")
  expect_error(f(c("a", "b")), "must be")
  expect_error(f(1), "must be")
  expect_error(f(NULL), "must be")
  expect_error(f(NA))

  f = function(x) checkArg(x, choices=list(NULL, 1L, data.frame()))
  f(1L)
  f(NULL)
  f(data.frame())
  expect_error(f(1), "must be")
  expect_error(f(list(1)), "must be")
})


test_that("checkArg with subset", {
  f = function(x) checkArg(x, subset=c("a", "b"))
  f("a")
  f("b")
  f(c("a", "b"))
  f(character(0))

  expect_error(f(1), "must be")
  expect_error(f(NA), "must be")

  f = function(x) checkArg(x, subset=list(NULL, 1L, data.frame()))
  f(1L)
  f(NULL)
  f(data.frame())
  f(list(NULL, data.frame()))
  expect_error(f(1), "must be")
  expect_error(f(list(1)), "must be")
})

test_that("checkArg with missing arg", {
  f = function(x) checkArg(x, "numeric")
  expect_error(f(), "Argument x must not be missing!")
})

test_that("checkArg with classes / s3 and s4", {
  x = 1
  class(x) = c("foo2", "foo1")
  expect_silent(checkArg(x, "foo1"))
  expect_silent(checkArg(x, "foo1", s4=FALSE))
  expect_silent(checkArg(x, "foo1", s4=TRUE))
  expect_silent(checkArg(x, "foo2"))
  expect_silent(checkArg(x, "foo2", s4=FALSE))
  expect_silent(checkArg(x, "foo2", s4=TRUE))
  mys41 = setClass("mys41", representation(x="numeric"))
  mys42 = setClass("mys42", contains="mys41", representation(y="numeric"))
  obj1 = mys41(x=3)
  obj2 = mys42(x=3, y=4)
  expect_silent(checkArg(obj1, "mys41", s4=TRUE))
  expect_silent(checkArg(obj2, "mys41", s4=TRUE))
  expect_silent(checkArg(obj2, "mys42", s4=TRUE))
})

test_that("checkArg with multiple classes", {
  expect_silent(checkArg(1, c("numeric", "list")))
  expect_silent(checkArg(1, c("numeric", "foo")))
  expect_silent(checkArg(1L, c("integer", "list")))
  expect_silent(checkArg(1L, c("integer", "foo")))
  expect_silent(checkArg(1L, c("numeric", "list")))
  expect_silent(checkArg(1L, c("numeric", "foo")))
})