types-check
Waliduj argumenty funkcji R za pomocą gotowych checkerów typu — jasne komunikaty błędów dla użytkownika.
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill types-check to zestaw funkcji do walidacji danych wejściowych w funkcjach R. Zawiera gotowe checkery typu (check_string, check_number_whole, check_bool i inne) zaprojektowane w stylu tidyverse, które generują czytelne i konkretne komunikaty błędów. Używaj go podczas pisania eksportowanych funkcji R, gdy chcesz upewnić się, że argumenty mają prawidłowy typ i zakres wartości. Skill wspiera walidację skalarów (pojedyncze wartości jak flagi, nazwy, liczby) oraz wektorów (logiczne, znakowe, ramki danych). Każdy checker pozwala na dostosowanie zachowania — na przykład dopuszczenie wartości NA, ustawienie zakresu min/max dla liczb czy kontrolę nieskończoności.
Jak używać
Uruchom w swoim projekcie R polecenie usethis::use_standalone("r-lib/rlang", "types-check"), aby zainstalować skill jako plik standalone z funkcjami check_*. Upewnij się, że rlang jest już importowany w twoim pakiecie.
W funkcji, którą chcesz zabezpieczyć, dodaj wywołania checkerów na początku ciała funkcji. Na przykład, jeśli funkcja przyjmuje argument name (ciąg znaków), dodaj check_string(name) lub check_name(name) dla nazw zmiennych.
Wybierz odpowiedni checker w zależności od typu argumentu: check_bool() dla flag logicznych (TRUE/FALSE), check_string() dla tekstu, check_number_whole() dla liczb całkowitych, check_number_decimal() dla liczb zmiennoprzecinkowych, check_logical() dla wektorów logicznych, check_character() dla wektorów znakowych, check_data_frame() dla ramek danych.
Dostosuj zachowanie checkera za pomocą argumentów opcjonalnych: allow_na = TRUE, jeśli funkcja powinna akceptować wartości NA, min i max dla checkerów liczb (check_number_whole, check_number_decimal) aby ograniczyć zakres, allow_infinite = TRUE/FALSE dla kontroli nieskończoności w liczbach.
Przetestuj funkcję z nieprawidłowymi danymi wejściowymi — checker automatycznie wyrzuci błąd z jasnym komunikatem wskazującym, co jest nie tak (np. "123 musi być ciągiem znaków, a nie liczbą 123").
Jeśli tworzysz własne funkcje walidacyjne, możesz je dodać do pliku standalone obok istniejących checkerów, zachowując ten sam styl komunikatów błędów.