Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yihui/testit
A simple package for testing R packages
https://github.com/yihui/testit
r r-package testing
Last synced: 9 days ago
JSON representation
A simple package for testing R packages
- Host: GitHub
- URL: https://github.com/yihui/testit
- Owner: yihui
- Created: 2013-06-26T01:13:14.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T20:45:26.000Z (4 months ago)
- Last Synced: 2024-10-13T14:54:03.061Z (25 days ago)
- Topics: r, r-package, testing
- Language: R
- Homepage: https://cran.rstudio.com/package=testit
- Size: 108 KB
- Stars: 58
- Watchers: 7
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
Awesome Lists containing this project
- jimsghstars - yihui/testit - A simple package for testing R packages (R)
README
# testit
[](https://github.com/yihui/testit/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/yihui/testit?branch=master)
[](https://cran.r-project.org/package=testit)
This package provides two simple functions (30 lines of code in total):
- `assert(fact, ...)`: think of it as `message(fact)` + `stopifnot(...)`
- `test_pkg(package)`: runs tests with all objects (exported or non-exported)
in the package namespace directly available, so no need to use the
triple-colon `package:::name` for non-exported objects
## Why?
Because it is tedious to type these commands repeatedly in tests:
``` r
message('checking if these numbers are equal...')
stopifnot(all.equal(1, 1+1e-10), 10*.1 == 1)
message('checking if a non-exported function works...')
stopifnot(is.character(package:::utility_foo(x = 'abcd', y = 1:100)))
```
With the two simple functions above, we type six letters (`assert`) instead of
sixteen (`message` + `stopifnot`), and `assert` is also a more intuitive
function name for testing purposes (you *assert* a fact followed by evidence):
``` r
assert('These numbers are equal', {
(all.equal(1, 1 + 1e-10))
(10 * .1 == 1)
})
assert('A non-exported function works', {
res = utility_foo(x = 'abcd', y = 1:100)
(is.character(res))
})
assert('T is TRUE and F is FALSE by default, but can be changed', {
(T == TRUE )
(F == FALSE)
T = FALSE
(T == FALSE)
})
```
## R CMD check
Put the tests under the directory `pkg_name/tests/testit/` (where `pkg_name` is
the root directory of your package), and write a `test-all.R` under
`pkg_name/tests/`:
``` r
library(testit)
test_pkg('pkg_name')
```
That is all for `R CMD check`. For package development, it is recommended to use
[**devtools**](https://cran.r-project.org/package=devtools). In particular,
`Ctrl/Cmd + Shift + L` in RStudio makes all objects in a package visible to you,
and you can run tests interactively.
## Installation
Stable version on CRAN:
``` r
install.packages('testit')
```
Development version:
``` r
remotes::install_github('yihui/testit')
```
## More
How about [**testthat**](https://CRAN.R-project.org/package=testthat)? Well,
this package is far less sophisticated than **testthat**. There is nothing fancy
in this package. Please do consider **testthat** if your tests require more
granularity. I myself do not use **testthat** because I'm too lazy to learn the
new vocabulary (`testthat::expect_xxx`). For **testit**, I do not need to think
if I should use `expect_equal`, `expect_equivalent`, or `expect_identical`; I
just write test conditions in parentheses that are expected to return `TRUE`.
That is the only single rule to remember.
There is no plan to add new features or reinvent anything in this package. It is
an intentionally tiny package.
Although he did not really mean it, [Xunzi](https://en.wikipedia.org/wiki/Xunzi)
said something that happens to apply well to unit testing:
> 不积跬步，无以至千里；不积小流，无以成江海。
This package is free and open source software, licensed under GPL-3.