Description Usage Arguments Details Value See Also Examples
inspect_character
checks if an object is a character vector.
This can be useful to validate inputs in user-defined functions.
1 | inspect_character(x, allow_nas = TRUE, warning_nas = FALSE)
|
x |
An arbitrary object. |
allow_nas |
Logical value. If |
warning_nas |
Logical value. If |
inspect_character
conducts a series of tests to check if x
is a
character vector. Namely, inspect_character
checks if:
x
is NULL
or empty.
x
is an atomic vector.
The typeof
x
is character.
There are NA
or NaN
values in x
.
inspect_character
does not return any output. There are three
possible outcomes:
The call is silent if:
x
is a character vector and there are no NA
or NaN
values in x
.
x
is a character vector, there are some NA
or NaN
values in x
,
allow_nas
is set to TRUE
and warning_nas
is set to FALSE
.
An informative warning message is thrown if x
is a character vector,
there are some NA
or NaN
values in x
and both allow_nas
and
warning_nas
are set to TRUE
.
An informative error message is thrown if:
x
is not a character vector.
x
is a character vector, there are some NA
or NaN
values in x
and allow_nas
is set to FALSE
.
inspect_character_match
to validate character
vectors with predefined allowed values.
inspect_true_or_false
to check if an object is a
non-missing logical value.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | # Calls that pass silently:
x1 <- "Kass"
x2 <- c("Kass", "Raftery")
x3 <- c("Kass", "Raftery", NA)
x4 <- letters
inspect_character(x1)
inspect_character(x2)
inspect_character(x3)
inspect_character(x4)
# Call that throws an informative warning message
y <- c("Kass", "Raftery", NA)
try(inspect_character(y, warning_nas = TRUE))
# Calls that throw informative error messages
try(inspect_character(y, allow_nas = FALSE))
mylist <- list(
NULL, character(0), 1,
c(1, 2), factor(c(1, 2)), list(c(1, 2)), NaN, NA
)
try(inspect_character(mylist[[1]]))
try(inspect_character(mylist[[2]]))
try(inspect_character(mylist[[3]]))
try(inspect_character(mylist[[4]]))
try(inspect_character(mylist[[5]]))
try(inspect_character(mylist[[6]]))
try(inspect_character(mylist[[7]]))
try(inspect_character(mylist[[8]]))
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.