chk

チェック

chk開発者がユーザー指定の関数の引数をチェックするための R パッケージです。

シンプル、カスタマイズ可能、高速になるように設計されています。

インストール

CRAN から最新リリース バージョンをインストールするには。

 install.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_関数) として提供します。

 library(chk)y <- "a"chk_string(y)
chk_flag(y)#> エラー:#> ! `y` はフラグ (TRUE または FALSE) でなければなりません。data <- data.frame(x = 1:2)
chk_range(nrow(data), c(3, 8))#> エラー:#> ! `nrow(data)` は 2 ではなく 3 から 8 の間でなければなりません。

または、ユーザー指定の引数をテストするために関数内で使用されます。

 my_fun <- function(x) {
  chk_flag(x) x}
my_fun(TRUE)#> [1] TRUEmy_fun(NA)#> `my_fun()` でエラー:#> ! `x` はフラグ (TRUE または FALSE) でなければなりません。

エラー メッセージは Tidyverse スタイル ガイドに従いますが、エラー自体はchk_errorクラスの rlang エラーです。

情報

詳細については、「はじめに」のビネットを参照してください。

インスピレーション

• データチェッカー

• チェッカー

• エラー

• それをテストする

貢献

問題があれば報告してください。

プルリクエストはいつでも歓迎です。

行動規範

chk プロジェクトは、貢献者の行動規範とともにリリースされていることに注意してください。このプロジェクトに貢献すると、その規約に従うことに同意したことになります。