https://github.com/socialresearchcentre/testdat
Data Unit Testing for R
https://github.com/socialresearchcentre/testdat
r-package
Last synced: 4 months ago
JSON representation
Data Unit Testing for R
- Host: GitHub
- URL: https://github.com/socialresearchcentre/testdat
- Owner: socialresearchcentre
- License: other
- Created: 2019-02-07T02:19:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T01:35:20.000Z (10 months ago)
- Last Synced: 2024-11-13T23:12:56.603Z (5 months ago)
- Topics: r-package
- Language: R
- Homepage: https://socialresearchcentre.github.io/testdat/
- Size: 1.26 MB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - socialresearchcentre/testdat - Data Unit Testing for R (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# testdat 
[](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[](https://github.com/socialresearchcentre/testdat/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/socialresearchcentre/testdat?branch=master)
[](https://CRAN.R-project.org/package=testdat)
## Overview
testdat is designed to ease data validation, particularly for complex data
processing, inspired by software unit testing. testdat extends the strong and
flexible unit testing framework already provided by
[testthat](https://testthat.r-lib.org/) with a family of functions and reporting
tools focused on checking of data frames.
Features include:
* A fully fledged test framework so you can spend more time specifying tests and
less time running them
* A set of common methods for simply specifying data validation rules
* Repeatability of data tests (avoid unintentionally breaking your data set!)
* Data-focused reporting of test results
## Installation
You can install the released version of testdat from
[CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("testdat")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("socialresearchcentre/testdat")
```
## Usage
See the [Introduction to
testdat](https://socialresearchcentre.github.io/testdat/articles/testdat.html)
vignette for a detailed introduction.
```{r error=TRUE}
library(testdat, warn.conflicts = FALSE)
library(dplyr, warn.conflicts = FALSE)
x <- tribble(
~id, ~pcode, ~state, ~nsw_only,
1, 2000, "NSW", 1,
2, 3123, "VIC", NA,
3, 2123, "NSW", 3,
4, 12345, "VIC", 3
)
with_testdata(x, {
test_that("id is unique", {
expect_unique(id)
})
test_that("variable values are correct", {
expect_values(pcode, 2000:2999, 3000:3999)
expect_values(state, c("NSW", "VIC"))
expect_values(nsw_only, 1:3) # by default expect_values allows NAs
})
test_that("filters applied correctly", {
expect_base(nsw_only, state == "NSW")
})
})
```