chk: chk_true – R documentation

Pricing

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

Get Started for Free

Documentation

chk

chk_true

Check TRUE

Description

Checks if TRUE using

is.logical(x) && length(x) == 1L && !anyNA(x) && x

Usage

chk_true(x, x_name = NULL)

vld_true(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.

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

Functions

vld_true: Validate TRUE

Examples

# chk_true
chk_true(TRUE)
try(chk_true(1))
# vld_true
vld_true(TRUE)
vld_true(FALSE)
vld_true(NA)
vld_true(0)
vld_true(c(TRUE, TRUE))

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