dataMaid is an R package for documenting and creating reports on data cleanliness.
This github page contains the development version of dataMaid. For the latest stable version download the package from CRAN directly using
install.packages("dataMaid")
To install the development version of dataMaid run the following
commands from within R (requires that the devtools package is already installed)
devtools::install_github('ekstroem/dataMaid')
A super simple way to get started is to load the package and use the
clean function on a data frame (if you try to clean the same data
frame several times then it may be necessary to add the replace=TRUE
argument to overwrite the existing report).
library(dataMaid)
data(trees)
clean(trees)
This will create a report with summaries and error checks for each
variable in the trees data frame.
The dataMaid package can also be used interactively by running checks for the individual variables
data(toyData)
check(toyData$var2) # Individual check
By default the standard battery of tests is run depending on the variable type. If we just want a specific test for, say, a numeric variable then we can specify that. See the documentation for an overview of the checks available or how to create and include your own tests.
check(toyData$var2, numericChecks = "identifyMissing")
We can also access the graphics or summary tables that are produced for a variable by calling the visualize or summarize functions
visualize(toyData$var2)
summarize(toyData$var2) # All summarues
summarize(toyData$var2, numericSummaries = c("centralValue", "minMax")) ## Only two summaries
This manuscript draft provides a detailed introduction to the dataMaid package. At one point it will be added as a vignette.
We are currently working on an online version of the tool, where users can upload their data and get a report. A prototype is already up and running - we just need to configure the R server correctly.