Quick Start | Basic Usage | Function Categories | Scalars / Atomic Types | Containers / Data Structures | Names and Sets | Files, Directories, and Paths | Date/Time and Special Classes | Combination Assertions | Usage Examples | Basic Assertion with Immediate Error | Using add Parameter for Error Collection | Combining Multiple Assertions | Custom Variable Names | Design Philosophy | Comparison: checkmate vs checkCLI | Error Message Examples | Type Validation Error | Multiple Validation Errors (Collected) | File Validation Error | Best Practices
Package: checkCLI 1.0
checkCLI: 'CLI' Messages for Checkmate Assertions and Checks
Providing more beautiful and more meaningful return messages for checkmate assertions and checks helping users to better understand errors.
Authors:
checkCLI_1.0.tar.gz
checkCLI_1.0.zip(r-4.7-any)checkCLI_1.0.zip(r-4.6-any)checkCLI_1.0.zip(r-4.5-any)
checkCLI_1.0.tgz(r-4.6-any)checkCLI_1.0.tgz(r-4.5-any)
checkCLI_1.0.tar.gz(r-4.7-any)checkCLI_1.0.tar.gz(r-4.6-any)
checkCLI_1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
checkCLI/json (API)
| # Install 'checkCLI' in R: |
| install.packages('checkCLI', repos = c('https://luizesser.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/luizesser/checkcli/issues
Last updated from:0a076af231. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 131 | ||
| source / vignettes | OK | 199 | ||
| linux-release | OK | 149 | ||
| macos-release | OK | 86 | ||
| macos-oldrel | OK | 101 | ||
| windows-devel | OK | 77 | ||
| windows-release | OK | 77 | ||
| windows-oldrel | OK | 75 | ||
| wasm-release | OK | 131 |
Exports:assert_array_cliassert_atomic_cliassert_atomic_vector_cliassert_character_cliassert_choice_cliassert_class_cliassert_cliassert_complex_cliassert_count_cliassert_data_frame_cliassert_date_cliassert_directory_cliassert_directory_exists_cliassert_disjunct_cliassert_double_cliassert_environment_cliassert_factor_cliassert_false_cliassert_file_cliassert_file_exists_cliassert_flag_cliassert_formula_cliassert_function_cliassert_int_cliassert_integer_cliassert_integerish_cliassert_list_cliassert_logical_cliassert_matrix_cliassert_multi_class_cliassert_names_cliassert_null_cliassert_number_cliassert_numeric_cliassert_os_cliassert_path_for_output_cliassert_permutation_cliassert_posixct_cliassert_r6_cliassert_raw_cliassert_scalar_cliassert_scalar_na_cliassert_set_equal_cliassert_string_cliassert_subset_cliassert_true_cliassert_vector_clicheck_array_clicheck_atomic_clicheck_atomic_vector_clicheck_character_clicheck_choice_clicheck_class_clicheck_complex_clicheck_count_clicheck_data_frame_clicheck_date_clicheck_directory_clicheck_directory_exists_clicheck_disjunct_clicheck_double_clicheck_environment_clicheck_factor_clicheck_false_clicheck_file_clicheck_file_exists_clicheck_flag_clicheck_formula_clicheck_function_clicheck_int_clicheck_integer_clicheck_integerish_clicheck_list_clicheck_logical_clicheck_matrix_clicheck_multi_class_clicheck_names_clicheck_null_clicheck_number_clicheck_numeric_clicheck_os_clicheck_path_for_output_clicheck_permutation_clicheck_posixct_clicheck_r6_clicheck_raw_clicheck_scalar_clicheck_scalar_na_clicheck_set_equal_clicheck_string_clicheck_subset_clicheck_true_clicheck_vector_clifix_braced_listfmt_bullet_climake_assertionsanitize_cli
Dependencies:backportscheckmatecligluelifecyclemagrittrpurrrrlangstringistringrvctrs
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Combine multiple CLI assertions | assert_cli |
| Container and data structure CLI assertions | assert_array_cli assert_data_frame_cli assert_environment_cli assert_factor_cli assert_formula_cli assert_function_cli assert_list_cli assert_matrix_cli assert_r6_cli assert_raw_cli assert_vector_cli checkcli-containers check_array_cli check_data_frame_cli check_environment_cli check_factor_cli check_formula_cli check_function_cli check_list_cli check_matrix_cli check_r6_cli check_raw_cli check_vector_cli |
| Date, time, and OS CLI assertions | assert_date_cli assert_os_cli assert_posixct_cli checkcli-datetime-os check_date_cli check_os_cli check_posixct_cli |
| File, directory, and path CLI assertions | assert_directory_cli assert_directory_exists_cli assert_file_cli assert_file_exists_cli assert_path_for_output_cli checkcli-files check_directory_cli check_directory_exists_cli check_file_cli check_file_exists_cli check_path_for_output_cli |
| Names, sets, and class CLI assertions | assert_choice_cli assert_class_cli assert_disjunct_cli assert_multi_class_cli assert_names_cli assert_permutation_cli assert_set_equal_cli assert_subset_cli checkcli-names-sets check_choice_cli check_class_cli check_disjunct_cli check_multi_class_cli check_names_cli check_permutation_cli check_set_equal_cli check_subset_cli |
| Scalar and atomic CLI assertions | assert_atomic_cli assert_atomic_vector_cli assert_character_cli assert_complex_cli assert_count_cli assert_double_cli assert_false_cli assert_flag_cli assert_integerish_cli assert_integer_cli assert_int_cli assert_logical_cli assert_null_cli assert_number_cli assert_numeric_cli assert_scalar_cli assert_scalar_na_cli assert_string_cli assert_true_cli checkcli-scalars check_atomic_cli check_atomic_vector_cli check_character_cli check_complex_cli check_count_cli check_double_cli check_false_cli check_flag_cli check_integerish_cli check_integer_cli check_int_cli check_logical_cli check_null_cli check_number_cli check_numeric_cli check_scalar_cli check_scalar_na_cli check_string_cli check_true_cli |
| Fix braced lists in messages | fix_braced_list |
| Format CLI bullets | fmt_bullet_cli |
| Make CLI-style assertion | make_assertion |
| Sanitize CLI message | sanitize_cli |