Skip to contents

Check Data

Source: R/check-data.R
check_data.Rd

Checks column names, values, number of rows and key for a data.frame.

Usage

check_data(
  x,
  values = NULL,
  exclusive = FALSE,
  order = FALSE,
  nrow = numeric(0),
  key = character(0),
  x_name = NULL
)

Arguments

x

The object to check.

values

A uniquely named list of atomic vectors of the column values.

exclusive

A flag specifying whether x must only include columns named in values.

order

A flag specifying whether the order of columns in x must match names in values.

nrow

A flag or a whole numeric vector of the value, value range or possible values.

key

A character vector of the columns that represent a unique key.

x_name

A string of the name of object x or NULL.

Value

An informative error if the test fails or an invisible copy of x.

See also

Other check: check_dim(), check_dirs(), check_files(), check_key(), check_names(), check_values()

Examples

check_data(data.frame())
check_data(data.frame(x = 2), list(x = 1))
try(check_data(data.frame(x = 2), list(y = 1L)))
#> Error in check_data(data.frame(x = 2), list(y = 1L)) : 
#>   `names(data.frame(x = 2))` must include 'y'.
try(check_data(data.frame(x = 2), list(y = 1)))
#> Error in check_data(data.frame(x = 2), list(y = 1)) : 
#>   `names(data.frame(x = 2))` must include 'y'.
try(check_data(data.frame(x = 2), nrow = 2))
#> Error in check_dim(x, dim = base::nrow, values = nrow, x_name = x_name,  : 
#>   `nrow(`data.frame(x = 2)`)` must be equal to 2.
#> Use `rlang::last_error()$y` to show the object compared to.