chk

chk

chk est un package R permettant aux développeurs de vérifier les arguments de fonction fournis par l'utilisateur.

Il est conçu pour être simple, personnalisable et rapide.

Installation

Pour installer la dernière version de CRAN.

 install.packages("chk")

Pour installer la dernière version de développement de r-universe.

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

Pour installer la dernière version de développement depuis 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")

Démonstration

chk fournit des vérifications simples couramment utilisées sous forme de (fonctions chk_ ) qui peuvent être combinées pour une vérification plus complexe.

 bibliothèque(chk)y <- "a"chk_string(y)
chk_flag(y)#> Erreur :#> ! `y` doit être un indicateur (VRAI ou FAUX).data <- data.frame(x = 1:2)
chk_range(nrow(data), c(3, 8))#> Erreur :#> ! `nrow(data)` doit être compris entre 3 et 8, et non 2.

Ou utilisé dans des fonctions pour tester les arguments fournis par l'utilisateur.

 mon_fun <- function(x) {
  chk_flag(x)x}
my_fun(TRUE)#> [1] TRUEmy_fun(NA)#> Erreur dans `my_fun()`:#> ! `x` doit être un indicateur (VRAI ou FAUX).

Les messages d'erreur suivent le guide de style Tidyverse tandis que les erreurs elles-mêmes sont des erreurs rlang de classe chk_error .

Information

Pour plus d’informations, consultez la vignette Premiers pas.

Inspiration

• datacheckr

• checkr

• se tromper

• tester ça

Contribution

Veuillez signaler tout problème.

Les demandes de tirage sont toujours les bienvenues.

Code de conduite

Veuillez noter que le projet chk est publié avec un code de conduite des contributeurs. En contribuant à ce projet, vous acceptez d'en respecter les termes.