The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.
chk is an R package for developers to check
user-supplied function arguments.
It is designed to be simple, customizable and fast.
chk provides simple commonly used checks as
(chk_ functions) which can be combined together for more
complex checking.
library(chk)
y <- "a"
chk_string(y)
chk_flag(y)
#> Error:
#> ! `y` must be a flag (TRUE or FALSE).
data <- data.frame(x = 1:2)
chk_range(nrow(data), c(3, 8))
#> Error:
#> ! `nrow(data)` must be between 3 and 8, not 2.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.
For more information see the Get Started vignette.
To install the release version from CRAN.
install.packages("chk")The website for the release version is at https://poissonconsulting.github.io/chk/.
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"))Please report any issues.
Pull requests are always welcome.
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.
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.