-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.qmd
60 lines (37 loc) · 3.85 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# prettycheck
<!-- badges: start -->
[](https://www.repostatus.org/#wip)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/danielvartan/prettycheck/actions/workflows/check-standard.yaml)
[](https://app.codecov.io/gh/danielvartan/prettycheck?branch=main)
[](https://choosealicense.com/licenses/mit/)
[](CODE_OF_CONDUCT.md)
<!-- badges: end -->
## Overview
Assertive programming doesn’t have to be ugly. If ultra-fast checks are not your top priority, `prettycheck` is for you. It provides a set of functions that produce pretty and informative error messages, primarily relying on the [`cli`](https://cli.r-lib.org/) package from [r-lib](https://github.com/r-lib). Inspired by the [`checkmate`](https://mllg.github.io/checkmate/) package, it places a strong emphasis on aesthetics and user experience.
`prettycheck` also adheres to the [tidyverse principles](https://tidyverse.tidyverse.org/articles/manifesto.html) and
integrates well with the [tidyverse ecosystem](https://www.tidyverse.org/).
If you need a faster system for assertive programming, we recommend the [`checkmate`](https://mllg.github.io/checkmate/) package. Since `prettycheck` uses the same structure for checks, transitioning to `checkmate` is straightforward. You can also use both packages together seamlessly.
## Installation
You can install `prettycheck` using the [`remotes`](https://github.com/r-lib/remotes) package:
``` {r}
#| eval: false
remotes::install_github("danielvartan/prettycheck")
```
## Usage
Like [`checkmate`](https://mllg.github.io/checkmate/), `prettycheck` includes four family of functions: `test_*()`, `check_*()`, `assert_*()`, and `expect_*()`.
The `test_*()` functions return a logical flag; the `check_*()` functions throw a warning message as a string if the condition is not met; and the `assert_*()` and `expect_*()` functions throw an error if the condition is not met. If the condition is met, `check_*()` returns a logical flag; `assert_*()` and `expect_*()` functions return the input object invisibly.
Here are some of the functions available for now:
- [`test_identical()`](https://danielvartan.github.io/prettycheck/reference/test_identical.html) `check_identical()` `assert_identical()`: Check if multiple objects are identical.
- [`test_length()`](https://danielvartan.github.io/prettycheck/reference/test_length.html) `check_length()` `assert_length()`: Check if an argument has a specific length.
- [`test_pick()`](https://danielvartan.github.io/prettycheck/reference/test_pick.html) `check_pick()` `assert_pick()`: Check how many arguments were picked.
Click [here](https://danielvartan.github.io/prettycheck/) to see the full list of functions.
## Contributing
We welcome contributions, including bug reports. Take a moment to review our [Guidelines for Contributing](https://danielvartan.github.io/prettycheck/CONTRIBUTING.html).
## License
[](https://opensource.org/license/mit/)
`prettycheck` code is released under the [MIT license](https://opensource.org/license/mit/).
<br>
Become an `prettycheck` supporter!
Click [here](https://github.com/sponsors/danielvartan) to make a donation. Please indicate the `prettycheck` package in your donation message.