check_types | R Documentation |
Check if each item of an argument has valid type, and if not, generate an error message.
check_types( x, valid, name = NULL, general = NULL, specific = NULL, supplement = NULL, ... )
x |
The argument to check, which must be a list. |
valid |
A character vector which contains the valid types. |
name |
A single character which gives the argument's name.
The name is used in the error message. By default, the name of the
argument passed to argument |
general |
Optional. A single character which is used to give a general statement of the error incurred. By default, this is generated automatically. |
specific |
Optional. A single character which gives a detailed
description of the error. |
supplement |
Optional. A (named) character vector which gives some
additional information about the error. The names are used to create
bullets, see |
... |
Optional. Additional arguments which can be retrieved with
|
returns an invisible NULL
if the argument is valid, or
generates an error message.
"Examples" section in check_type()
for how to customize
error message and how to add and retrieve additional arguments.
vignette("erify")
for a gentle introduction to this package.
## Not run: # argument to check arg <- as.list(1:10) check_types(arg, "character") # customize error message with `glue::glue()` syntax specific <- "`{name}[[{i}]]` is an {feature}, oh my god!" check_types(arg, "character", specific = specific) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.