Skip to contents

Check String

Source: R/chk-string.R
chk_string.Rd

Checks if string

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

Usage

chk_string(x, x_name = NULL)

vld_string(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_string(): Validate String

See also

Other chk_scalars: chk_date(), chk_date_time(), chk_number(), chk_scalar(), chk_tz(), chk_whole_number()

Examples

# chk_string
chk_string("1")
try(chk_string(1))
#> Error in eval(expr, envir) : 
#>   `1` must be a string (non-missing character scalar).
# vld_string
vld_string("1")
#> [1] TRUE
vld_string("")
#> [1] TRUE
vld_string(1)
#> [1] FALSE
vld_string(NA_character_)
#> [1] FALSE
vld_string(c("1", "1"))
#> [1] FALSE