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_ ), которые можно комбинировать для более сложной проверки.

 библиотека(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)` должно быть между 3 и 8, а не 2.

Или используется внутри функций для проверки аргументов, предоставленных пользователем.

 my_fun <- функция (x) {
  chk_flag(x) x}
my_fun(TRUE)#> [1] TRUEmy_fun(NA)#> Ошибка в `my_fun()`:#> ! `x` должен быть флагом (TRUE или FALSE).

Сообщения об ошибках соответствуют руководству по стилю tidyverse, а сами ошибки являются ошибками rlang класса chk_error .

Информация

Для получения дополнительной информации см. краткий обзор «Начало работы».

Вдохновение

• проверка данных

• проверка

• ошибаться

• проверить это

Вклад

Пожалуйста, сообщайте о любых проблемах.

Запросы на вытягивание всегда приветствуются.

Нормы поведения

Обратите внимание, что проект chk выпущен с Кодексом поведения участников. Внося свой вклад в этот проект, вы соглашаетесь соблюдать его условия.