checkmate: checkRaw – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

checkmate

checkRaw

Check if an argument is a raw vector

Description

Check if an argument is a raw vector

Usage

checkRaw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE
)

check_raw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE
)

assertRaw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE,
  .var.name = vname(x),
  add = NULL
)

assert_raw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE,
  .var.name = vname(x),
  add = NULL
)

testRaw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE
)

test_raw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE
)

expect_raw(
  x,
  len = NULL,
  min.len = NULL,
  max.len = NULL,
  names = NULL,
  null.ok = FALSE,
  info = NULL,
  label = vname(x)
)

Arguments

`x`	[any] Object to check.
`len`	[`integer(1)`] Exact expected length of `x`.
`min.len`	[`integer(1)`] Minimal length of `x`.
`max.len`	[`integer(1)`] Maximal length of `x`.
`names`	[`character(1)`] Check for names. See `checkNamed` for possible values. Default is “any” which performs no check at all. Note that you can use `checkSubset` to check for a specific set of names.
`null.ok`	[`logical(1)`] If set to `TRUE`, `x` may also be `NULL`. In this case only a type check of `x` is performed, all additional checks are disabled.
`.var.name`	[`character(1)`] Name of the checked object to print in assertions. Defaults to the heuristic implemented in `vname`.
`add`	[`AssertCollection`] Collection to store assertion messages. See `AssertCollection`.
`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 assertRaw/assert_raw return x invisibly, whereas checkRaw/check_raw and testRaw/test_raw return TRUE. If the check is not successful, assertRaw/assert_raw throws an error message, testRaw/test_raw returns FALSE, and checkRaw returns a string with the error message. The function expect_raw always returns an expectation.

Examples

testRaw(as.raw(2), min.len = 1L)

checkmate

Fast and Versatile Argument Checks

v2.0.0

BSD_3_clause + file LICENSE

Authors

Michel Lang [cre, aut] (<https://orcid.org/0000-0001-9754-0393>), Bernd Bischl [ctb]

Initial release

checkRaw

Description

Usage

Arguments

Value

See Also

Examples

checkmate

We don't support your browser anymore