Repository files navigation

chk is an R package for developers to check user-supplied functionarguments.

It is designed to be simple, customizable and fast.

chk provides simple commonly used checks as (chk_ functions) whichcan 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] TRUEmy_fun(NA)#> Error in `my_fun()`:#> ! `x` must be a flag (TRUE or FALSE).

Error messages follow thetidyverse styleguide while the errorsthemselves arerlangerrors of classchk_error.

For more information see theGetStartedvignette.

To install the release version fromCRAN.

install.packages("chk")

The website for the release version is athttps://poissonconsulting.github.io/chk/.

To install the development version fromGitHub

# install.packages("remotes")remotes::install_github("poissonconsulting/chk")

or fromr-universe.

install.packages("chk",repos= c("https://poissonconsulting.r-universe.dev","https://cloud.r-project.org"))

• datacheckr
• checkr
• err
• testthat

Please report anyissues.

Pull requests arealways welcome.

Please note that the chk project is released with aContributor Code ofConduct.By contributing to this project, you agree to abide by its terms.