assert_is_data.table {assertive.types}R Documentation

Is the input a data.table?

Description

Checks to see if the input is a data.table.

Usage

assert_is_data.table(x, severity = getOption("assertive.severity", "stop"))

is_data.table(x, .xname = get_name_in_parent(x))

Arguments

x

Input to check.

severity

How severe should the consequences of the assertion be? Either "stop", "warning", "message", or "none".

.xname

Not intended to be used directly.

Value

is_data.table wraps is.data.table, providing more information on failure. The assert_* functions return nothing but throws an error if the corresponding is_* function returns FALSE.

See Also

is.data.table.

Examples

if(requireNamespace("data.table"))
{
  assert_is_data.table(data.table::data.table(x = 1:5))
  #These examples should fail.
  assertive.base::dont_stop(assert_is_data.table(list(1,2,3)))
} else
{
  message("This example requires the data.table package to be installed.")
}

[Package assertive.types version 0.0-3 Index]