checkString {checkmate} | R Documentation |
Check if an argument is a string
Description
A string is defined as a scalar character vector.
To check for vectors of arbitrary length, see checkCharacter
.
Usage
checkString(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE
)
check_string(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE
)
assertString(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
assert_string(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
testString(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE
)
test_string(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE
)
expect_string(
x,
na.ok = FALSE,
n.chars = NULL,
min.chars = NULL,
max.chars = NULL,
pattern = NULL,
fixed = NULL,
ignore.case = FALSE,
null.ok = FALSE,
info = NULL,
label = vname(x)
)
Arguments
x |
[any] |
na.ok |
[ |
n.chars |
[ |
min.chars |
[ |
max.chars |
[ |
pattern |
[ |
fixed |
[ |
ignore.case |
[ |
null.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[ |
label |
[ |
Details
This function does not distinguish between
NA
, NA_integer_
, NA_real_
, NA_complex_
NA_character_
and NaN
.
Value
Depending on the function prefix:
If the check is successful, the functions
assertString
/assert_string
return
x
invisibly, whereas
checkString
/check_string
and
testString
/test_string
return
TRUE
.
If the check is not successful,
assertString
/assert_string
throws an error message,
testString
/test_string
returns FALSE
,
and checkString
/check_string
return a string with the error message.
The function expect_string
always returns an
expectation
.
See Also
Other scalars:
checkCount()
,
checkFlag()
,
checkInt()
,
checkNumber()
,
checkScalar()
,
checkScalarNA()
Examples
testString("a")
testString(letters)