Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danielvartan committed Oct 18, 2024
1 parent 4d16b06 commit 1324d5e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This package incorporates C code from the [`checkmate`](https://mllg.github.io/
Additionally, it is worth noting that the [MIT License](https://opensource.org/license/mit) is compatible with the BSD-3-Clause License.

```
Copyright (c) 2023, Michel Lang
Copyright (c) 2024, Michel Lang
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ 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, since `prettycheck` also uses `checkmate` under the hood.
seamlessly.

## Installation

Expand All @@ -52,19 +52,20 @@ includes four family of functions: `test_*()`, `check_*()`,
`assert_*()`, and `expect_*()`.

The `test_*()` functions return a logical flag; the `check_*()`
functions throw a warning message 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_*()`, `assert_*()`, and
`expect_*()` functions return the input object invisibly.
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()` `expect_identical()`: Check
if multiple objects are identical.
`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()` `expect_length()`: Check if an
argument has a specific length.
`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.

Expand Down
4 changes: 2 additions & 2 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Assertive programming doesn’t have to be ugly. If ultra-fast checks are not yo
`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, since `prettycheck` also uses `checkmate` under the hood.
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

Expand All @@ -54,7 +54,7 @@ remotes::install_github("danielvartan/prettycheck")

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 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_*()`, `assert_*()`, and `expect_*()` functions return the input object invisibly.
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:

Expand Down
2 changes: 1 addition & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
editor: source

project:
output_dir: "."
output-dir: "."
render: [README.qmd]
post-render: "R/.post-render.R"

Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@
},
"SystemRequirements": null
},
"fileSize": "82.201KB",
"fileSize": "80.735KB",
"citation": [
{
"@type": "CreativeWork",
Expand Down

0 comments on commit 1324d5e

Please sign in to comment.