datacheck: Tools for Checking Data Consistency

Functions to check variables against a set of data quality rules. A rule file can be accompanied by look-up tables. In addition, there are some convenience functions that may serve as an example for defining clearer 'data rules'. An HTML based user interface facilitates initial exploration of the functionality.

Author"Simon, Reinhard (CIP)" <R.SIMON@CGIAR.ORG>, Jose Francisco Loff <jfloff at phistat.com>
Date of publication2015-04-18 08:56:10
Maintainer"Simon, Reinhard (CIP)" <R.SIMON@CGIAR.ORG>
LicenseMIT + file LICENSE
Version1.2.2
https://github.com/c5sire/datacheck

View on CRAN

Man pages

as_rules: Converts a vector of lines into a rules data frame

as.rules: Converts a vector of lines into a rules data frame

datacheck-package: Check a table against a set of constraints or rules defined...

datadict_profile: Create a data quality profile (main function)

datadict.profile: Create a data quality profile (main function)

has_punct: Tests for presence of most common punctuation characters

has.punct: Tests for presence of most common punctuation characters

has_rule_errors: Quick check if a rule profile on a table has any errors.

has.ruleErrors: Quick check if a rule profile on a table has any errors.

heatmap_quality: Draws a heatmap based on data quality scores

heatmap.quality: Draws a heatmap based on data quality scores

is_datadict_profile: is.datadict.profile

is.datadict.profile: is.datadict.profile

is_one_of: Tests if a string or 'factor level' is one of a pre-defined...

is.oneOf: Tests if a string or 'factor level' is one of a pre-defined...

is_only_lowers: Tests if a string has only lower case letters

is.onlyLowers: Tests if a string has only lower case letters

is_proper_name: Tests if string is like a proper name with inital letter in...

is.properName: Tests if string is like a proper name with inital letter in...

is_within_range: Tests if a numeric value is between a minimal and maximum...

is.withinRange: Tests if a numeric value is between a minimal and maximum...

pkg_version: Get the current version of a package

pkg.version: Get the current version of a package

prep4rep: Prepares a summary table for display in a 'printed' report.

read_rules: Reads a file containing rules in data dictionary format.

read.rules: Reads a file containing rules in data dictionary format.

rule_coverage: Dotchart of rules per variable

ruleCoverage: Dotchart of rules per variable

run_datacheck: Presents the packages graphical user interface

runDatacheck: Presents the packages graphical user interface

score_sum: Line chart of cumulative sum of rule scores.

scoreSum: Line chart of cumulative sum of rule scores.

short_summary: Produces a tabular summary of descriptive statistics using...

shortSummary: Produces a tabular summary of descriptive statistics using...

Files in this package

datacheck
datacheck/inst
datacheck/inst/examples
datacheck/inst/examples/rules1.R
datacheck/inst/examples/location.csv
datacheck/inst/examples/is_onlyLowers.R
datacheck/inst/examples/rules2.R
datacheck/inst/examples/is_oneOf.R
datacheck/inst/examples/person.csv
datacheck/inst/examples/soil_rules.R
datacheck/inst/examples/db-err.csv
datacheck/inst/examples/datadict_profile.R
datacheck/inst/examples/is_withinRange.R
datacheck/inst/examples/soilsamples.csv
datacheck/inst/examples/person_rules.R
datacheck/inst/examples/db.csv
datacheck/inst/examples/has_ruleErrors.R
datacheck/inst/examples/rules.R
datacheck/inst/examples/is_properName.R
datacheck/inst/examples/has_punct.R
datacheck/inst/www
datacheck/inst/www/ui.R
datacheck/inst/www/server.R
datacheck/inst/www/js
datacheck/inst/www/js/timer.js
datacheck/inst/doc
datacheck/inst/doc/index.html
datacheck/inst/doc/RN_1.0.4.pdf
datacheck/inst/doc/RN_1.2.2.pdf
datacheck/inst/doc/index.Rmd
datacheck/inst/doc/RN_1.1.0.md
datacheck/inst/doc/RN_1.0.4.md
datacheck/inst/doc/RN_1.1.0.pdf
datacheck/inst/doc/RN_1.2.2.md
datacheck/NAMESPACE
datacheck/NEWS
datacheck/R
datacheck/R/datacheck.R
datacheck/vignettes
datacheck/vignettes/index.html
datacheck/vignettes/index.Rmd
datacheck/vignettes/custom.css
datacheck/vignettes/style.R
datacheck/README.md
datacheck/MD5
datacheck/DESCRIPTION
datacheck/man
datacheck/man/is_datadict_profile.Rd datacheck/man/datadict.profile.Rd datacheck/man/run_datacheck.Rd datacheck/man/as.rules.Rd datacheck/man/is.onlyLowers.Rd datacheck/man/is_only_lowers.Rd datacheck/man/read_rules.Rd datacheck/man/is.withinRange.Rd datacheck/man/runDatacheck.Rd datacheck/man/read.rules.Rd datacheck/man/rule_coverage.Rd datacheck/man/is_proper_name.Rd datacheck/man/as_rules.Rd datacheck/man/prep4rep.Rd datacheck/man/heatmap_quality.Rd datacheck/man/scoreSum.Rd datacheck/man/is.datadict.profile.Rd datacheck/man/is.properName.Rd datacheck/man/pkg.version.Rd datacheck/man/has.punct.Rd datacheck/man/pkg_version.Rd datacheck/man/score_sum.Rd datacheck/man/datacheck-package.Rd datacheck/man/has_punct.Rd datacheck/man/ruleCoverage.Rd datacheck/man/is_one_of.Rd datacheck/man/shortSummary.Rd datacheck/man/has_rule_errors.Rd datacheck/man/heatmap.quality.Rd datacheck/man/has.ruleErrors.Rd datacheck/man/short_summary.Rd datacheck/man/is_within_range.Rd datacheck/man/datadict_profile.Rd datacheck/man/is.oneOf.Rd
datacheck/LICENSE

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.