Skip to contents

Check Data

Source: R/chk-data.R
chk_data.Rd

Checks data.frame using

inherits(x, "data.frame")

Usage

chk_data(x, x_name = NULL)

vld_data(x)

Arguments

x

The object to check.

x_name

A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

  • vld_data(): Validate Data

See also

Other chk_is: chk_array(), chk_atomic(), chk_function(), chk_is(), chk_matrix(), chk_numeric(), chk_s3_class(), chk_s4_class(), chk_vector(), chk_whole_numeric()

Examples

# chk_data
chk_data(data.frame(x = 1))
try(chk_data(1))
#> Error in eval(expr, envir) : `1` must be a data.frame.
# vld_data
vld_data(data.frame())
#> [1] TRUE
vld_data(data.frame(x = 1))
#> [1] TRUE
vld_data(c(x = 1))
#> [1] FALSE