chk

查克

chk是一个 R 包，供开发人员检查用户提供的函数参数。

它的设计简单、可定制且快速。

安装

从 CRAN 安装最新版本。

安装.packages("chk")

安装 r-universe 的最新开发版本。

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

从 GitHub 安装最新的开发版本

# install.packages("pak", repos = sprintf("https://r-lib.github.io/p/pak/stable/%s/%s/%s", .Platform$pkgType, R.Version ()$os, R.Version()$arch))pak::pak("poissonconsulting/chk")

示范

chk提供了简单的常用检查（ chk_函数），可以将它们组合在一起以进行更复杂的检查。

库（chk）y <-“a”chk_string（y）
chk_flag(y)#> 错误：#> ! `y` 必须是一个标志（TRUE 或 FALSE）。data <- data.frame(x = 1:2)
chk_range(nrow(数据), c(3, 8))#> 错误:#> ! `nrow(data)` 必须介于 3 到 8 之间，而不是 2。

或者使用内部函数来测试用户提供的参数。

 my_fun <- 函数(x) {
  chk_flag(x) x}
my_fun(TRUE)#> [1] TRUEmy_fun(NA)#> `my_fun()` 出错：#> ！ `x` 必须是一个标志（TRUE 或 FALSE）。

错误消息遵循 tidyverse 风格指南，而错误本身是chk_error类的 rlang 错误。

信息

有关更多信息，请参阅入门小插图。

灵感

• 数据检查器

• 检查器

• 犯错

• 测试那个

贡献

请报告任何问题。

始终欢迎拉取请求。

行为守则

请注意，chk 项目是随贡献者行为准则一起发布的。通过为该项目做出贡献，您同意遵守其条款。