Skip to content
Identifies Unexpected Values in the PROMISE Datasets
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
docs
man
tests
.Rbuildignore
.gitignore
.gitlab-ci.yml
.travis.yml
DESCRIPTION
LICENSE
NAMESPACE
NEWS.md
PROMISE.audit.Rproj
README.Rmd
README.md
_pkgdown.yml
codecov.yml

README.md

PROMISE.audit

Travis-CI Build Status Coverage Status

The aim of this package is to run audits on datasets to check for errors or typos in values. For instance, with a column called MonthsPerYear, the values should be integers that go from 1 to 12. If there are violations to this pattern, the values need to be investigated at the raw data source. This is a companion package to the main PROMISE package (see website).

In general, this audit package is a thin wrapper around assertr. It simplifies some common uses of assertr as well as creating an easy interface to viewing the errors from multiple audit checks.

Installation

Only on GitHub right now, and is in development.

# install.packages("devtools")
devtools::install_github("lwjohnst86/PROMISE.audit")

Usage

library(PROMISE.audit)
library(magrittr)
audit <- swiss %>% 
    chk_in_range(3, 20, "Examination") %>% 
    chk_in_set(1:10, "Education") %>% 
    chk_outliers(3, "Fertility")
#> Warning: Prefixing `UQS()` with the rlang namespace is deprecated as of rlang 0.3.0.
#> Please use the non-prefixed form or `!!!` instead.
#> 
#>   # Bad:
#>   rlang::expr(mean(rlang::UQS(args)))
#> 
#>   # Ok:
#>   rlang::expr(mean(UQS(args)))
#> 
#>   # Good:
#>   rlang::expr(mean(!!!args))
#> 
#> This warning is displayed once per session.
aud_report(audit) %>% 
    knitr::kable()
Column Fails Values RowNum
Examination 14 21, 22, 26, 31, 25, 29, 35, 37 12, 15, 18, 19, 21, 23, 29, 39, 40, 41, 42, 44, 45, 47
Education 17 12, 15, 13, 28, 20, 19, 11, 32, 53, 29 1, 5, 10, 12, 14, 18, 19, 23, 29, 38, 39, 40, 41, 42, 45, 46, 47
You can’t perform that action at this time.