chk: check_data – R documentation

Pricing

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

Get Started for Free

Documentation

chk

check_data

Check Data

Description

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.

Examples

check_data(data.frame())
check_data(data.frame(x = 2), list(x = 1))
try(check_data(data.frame(x = 2), list(y = 1L)))
try(check_data(data.frame(x = 2), list(y = 1)))
try(check_data(data.frame(x = 2), nrow = 2))

chk

Check User-Supplied Function Arguments

v0.5.1

MIT + file LICENSE

Authors

Joe Thorley [aut, cre] (<https://orcid.org/0000-0002-7683-4592>), Kirill Müller [aut] (<https://orcid.org/0000-0002-1416-3412>), Ayla Pearson [ctb] (<https://orcid.org/0000-0001-7388-1222>), Poisson Consulting [cph, fnd]

Initial release