Title: cli messages for checkmate assertions and checks
Description: Providing more beautiful and more meaningful return messages for checkmate assertions and checks helping users to better understand errors.
checkCLI is an R package that enhances the checkmate package by providing more informative and visually appealing error messages using the cli package. Instead of cryptic error messages, users receive clear, formatted, and contextual feedback when assertions fail.
The package wraps all major checkmate assertion and check functions with CLI-enhanced versions, automatically generating beautiful, colored error messages that help developers and users understand exactly what went wrong with their data validation.
- Enhanced Error Messages: Converts raw checkmate error messages into formatted, readable CLI messages
- Comprehensive Coverage: Wraps all major checkmate assertion and check functions
- Easy Integration: Drop-in replacements for standard checkmate functions with
_clisuffix - Beautiful Formatting: Leverages the
clipackage for colored, bullet-pointed error output - Flexible Error Handling: Supports both immediate errors and error collection for batch validation
- Character Escaping: Safely handles special characters in error messages
# Install from GitHub
devtools::install_github("luizesser/checkCLI")The cli package respects terminal capabilities. Some terminals may not support colors. This is normal and messages will still display correctly.
The package automatically escapes special characters (braces) to prevent formatting issues. Manual escaping is not needed.
Ensure you're using checkmate::AssertCollection$new() to create collection objects before passing to the add parameter.
Contributions are welcome! Please ensure that:
- All
checkmatecheck functions have corresponding_cliwrapped versions - Error messages remain clear and actionable
- Documentation is updated with new functions
- Tests cover new functionality
Questions or Issues? Please open an issue on GitHub or contact the package maintainer.