predicates-type: Type predicates

In egnha/rong: Functional Input Validation

Description

Type predicates

Usage

chk_null(x)

chk_not_null(x)

chk_symbol(x)

chk_pairlist(x)

chk_closure(x)

chk_environment(x)

chk_language(x)

chk_atomic(x, n = NULL)

chk_vector(x, n = NULL)

chk_logical(x, n = NULL)

chk_boolean(x)

chk_numerical(x, n = NULL)

chk_number(x)

chk_integer(x, n = NULL)

chk_integerish(x, n = NULL)

chk_double(x, n = NULL, finite = NULL)

chk_complex(x, n = NULL)

chk_character(x, n = NULL, encoding = NULL)

chk_string(x)

chk_list(x, n = NULL)

chk_raw(x, n = NULL)

Arguments

x	Object to test.
n	Length.
encoding	Encoding of a string or character vector. One of UTF-8, latin1, or unknown.
finite	Whether values must be finite. Examples of non-finite values are Inf, -Inf and NaN.

See Also

• rlang type predicates, which underlie the length-dependent predicates (except chk_numerical())

• Object predicates, for verifying identities that are not characterized by type, e.g., data frames, which have type list

Examples

f <- function(x, y, z) NULL

## Require all arguments to be integer (vectors)
foo <- firmly(f, chk_integer())
foo(0L, 1:2, length(letters))
## Not run: 
foo(0L, c(1, 2), length(letters))
## End(Not run)

## Require all arguments to be scalar integers
bar <- firmly(f, chk_integer(n = 1))
bar(0L, 1L, length(NA))
## Not run: 
bar(0L, 1L, lengths(letters))
## End(Not run)

## Require x, y to be character (vectors), and z to be an length-1 list
baz <- firmly(f, chk_character(x, y), chk_list(n = 1, z))
baz(letters, "text", list(1))
## Not run: 
baz(0, "text", list(1, 2))
## End(Not run)

egnha/rong documentation built on May 7, 2019, 9:48 p.m.