Learn R Programming

⚠️There's a newer version (1.0.5) of this package.Take me there.

dataReporter (version 1.0.2)

Reproducible Data Screening Checks and Report of Possible Errors

Description

Data screening is an important first step of any statistical analysis. 'dataReporter' auto generates a customizable data report with a thorough summary of the checks and the results that a human can use to identify possible errors. It provides an extendable suite of test for common potential errors in a dataset. See Petersen AH, Ekstrøm CT (2019). "dataMaid: Your Assistant for Documenting Supervised Data Quality Screening in R." _Journal of Statistical Software_, *90*(6), 1-38 for more information.

Copy Link

Version

Install

install.packages('dataReporter')

Monthly Downloads

570

Version

1.0.2

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Claus Ekstrom

Last Published

November 11th, 2021

Functions in dataReporter (1.0.2)

basicVisualCFLB

importFrom stats na.omit
allCheckFunctions

Overview of all available checkFunctions
artData

Semi-artificial data about masterpieces of art
allClasses

Vector of all variable classes in dataReporter
centralValue

summaryFunction for central values
basicVisual

allSummaryFunctions

Overview of all available summaryFunctions
allVisualFunctions

Overview of all available visualFunctions
bigPresidentData

Semi-artificial data about the US presidents (extended version)
check

Perform checks of potential errors in variable/dataset
defaultFactorChecks

Default checks for factor variables
defaultDateSummaries

Default summary functions for Date variables
defaultIntegerSummaries

Default summary functions for integer variables
defaultDateChecks

Default checks for Date variables
defaultIntegerChecks

Default checks for integer variables
identifyNums

A checkFunction
identifyMissing

A checkFunction for identifying miscoded missing values.
defaultFactorSummaries

Default summary functions for factor variables
defaultNumericChecks

Default checks for numeric variables
checkFunction

Create an object of class checkFunction
checkResult

Create object of class checkResult
classes

Extract the contents of the attribute classes
defaultCharacterChecks

Default checks for character variables
defaultNumericSummaries

Default summary functions for numeric variables
defaultLabelledChecks

Default checks for labelled variables
defaultCharacterSummaries

Default summary functions for character variables
defaultLabelledSummaries

Default summary functions for labelled variables
isCPR

Check if a variable consists of Danish CPR numbers
identifyWhitespace

A checkFunction for identifying whitespace
summaryResult

Create object of class summaryResult
defaultLogicalChecks

Default checks for logical variables
identifyOutliers

A checkFunction for identifying outliers
tableVisual

Produce tables for the makeDataReport visualizations.
identifyOutliersTBStyle

A checkFunction for identifying outliers Turkey Boxstole style
isSingular

Check if a variable only contains a single value
isKey

Check if a variable qualifies as a key
defaultLogicalSummaries

Default summary functions for logical variables
exampleData

Example data with zero-inflated variables
description

Extract the contents of the attribute description
standardVisual

Produce distribution plots using ggplot from ggplot2.
smartNum

Smart class to handle numerics as factor
messageGenerator

Produce a message for the output of a checkFunction
testData

Extended example data to test the features of dataReporter
isSupported

Check if a variable has a class supported by dataReporter
defaultHavenlabelledChecks

Default checks for haven_labelled variables
identifyCaseIssues

A checkFunction for identifying case issues
defaultHavenlabelledSummaries

Default summary functions for haven_labelled variables
countMissing

Summary function for missing values
identifyLoners

A checkFunction for identifying sparsely represented values (loners)
minMax

summaryFunction for minimum and maximum
summarize

Summarize a variable/dataset
uniqueValues

summaryFunction for unique values
presidentData

Semi-artificial data about the US presidents
summaryFunction

Create an object of class summaryFunction
toyData

Small example data to show the features of dataReporter
visualize

Produce distribution plots
visualFunction

Create an object of class visualFunction
variableType

Summary function for original class
quartiles

summaryFunction for quartiles
refCat

summaryFunction that finds reference level for factor variables
render

Simplified Rmarkdown rendering
setChecks

Set check arguments for makeDataReport
makeCodebook

Produce a data codebook
setSummaries

Set summary arguments for makeDataReport
setVisuals

Set visual arguments for makeDataReport
whoami_available

Find out if the whoami package binaries is installed (git + whoami)
makeDataReport

Produce a data report