Assert that an object is a data frame — assert_data

Checks that x is a data frame. Note that data tables and tibbles are also data frames and pass this check.

Usage

assert_data_frame(
  x,
  null_ok = FALSE,
  arg = rlang::caller_arg(x),
  call = rlang::caller_env()
)

x: Object to check.
null_ok: Single logical. If TRUE, a NULL value passes the check without error. Use this for optional arguments that default to NULL. Defaults to FALSE, so NULL is rejected unless you opt in.
arg: Name used to refer to x in error messages. Defaults to the name of the expression passed as x.
call: Environment used as the error's call context. Defaults to the calling function, so errors point at the user's code.

The input x, invisibly.

assert_data_frame(data.frame(a = 1, b = 2))