Check User-Supplied Function Arguments (original) (raw)
chk
is an R package for developers to check user-supplied function arguments.
It is designed to be simple, customizable and fast.
Demonstration
chk
provides simple commonly used checks as (chk_
functions) which can be combined together for more complex checking.
Or used inside functions to test user-provided arguments.
my_fun <- function(x) {
chk_flag(x)
x
}
my_fun(TRUE)
#> [1] TRUE
my_fun(NA)
#> Error in `my_fun()`:
#> ! `x` must be a flag (TRUE or FALSE).
Error messages follow the tidyverse style guide while the errors themselves are rlang errors of class chk_error
.
Information
For more information see the Get Started vignette.
Installation
Development
To install the development version from GitHub
# install.packages("remotes")
remotes::install_github("poissonconsulting/chk")
or from r-universe.
install.packages("chk", repos = c("https://poissonconsulting.r-universe.dev", "https://cloud.r-project.org"))
Code of Conduct
Please note that the chk project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.