chk

verificar

chk é um pacote R para desenvolvedores verificarem argumentos de função fornecidos pelo usuário.

Ele foi projetado para ser simples, personalizável e rápido.

Instalação

Para instalar a versão mais recente do CRAN.

 instalar.packages("chk")

Para instalar a versão de desenvolvimento mais recente do r-universe.

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

Para instalar a versão de desenvolvimento mais recente do 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")

Demonstração

chk fornece verificações simples comumente usadas como (funções chk_ ) que podem ser combinadas para verificações mais complexas.

 biblioteca(chk)y <- "a"chk_string(y)
chk_flag(y)#> Erro:#> ! `y` deve ser um sinalizador (TRUE ou FALSE).data <- data.frame(x = 1:2)
chk_range(nrow(dados), c(3, 8))#> Erro:#> ! `nrow(data)` deve estar entre 3 e 8, não 2.

Ou usado dentro de funções para testar argumentos fornecidos pelo usuário.

 minha_fun <- função(x) {
  chk_flag(x)x}
my_fun(TRUE)#> [1] TRUEmy_fun(NA)#> Erro em `my_fun()`:#> ! `x` deve ser um sinalizador (TRUE ou FALSE).

As mensagens de erro seguem o guia de estilo tidyverse, enquanto os próprios erros são erros rlang da classe chk_error .

Informação

Para obter mais informações, consulte a vinheta Primeiros passos.

Inspiração

• verificador de dados

• verificar

• errar

• testar isso

Contribuição

Por favor, relate quaisquer problemas.

Solicitações pull são sempre bem-vindas.

Código de Conduta

Observe que o projeto chk é lançado com um Código de Conduta do Colaborador. Ao contribuir para este projeto, você concorda em cumprir seus termos.