Package: dataReporter 1.0.4

dataReporter: Reproducible Data Screening Checks and Report of Possible Errors

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 <doi:10.18637/jss.v090.i06> for more information.

Authors:Anne Helby Petersen [aut], Claus Thorn Ekstrøm [aut, cre]

dataReporter_1.0.4.tar.gz
dataReporter_1.0.4.zip(r-4.5)dataReporter_1.0.4.zip(r-4.4)dataReporter_1.0.4.zip(r-4.3)
dataReporter_1.0.4.tgz(r-4.4-any)dataReporter_1.0.4.tgz(r-4.3-any)
dataReporter_1.0.4.tar.gz(r-4.5-noble)dataReporter_1.0.4.tar.gz(r-4.4-noble)
dataReporter_1.0.4.tgz(r-4.4-emscripten)dataReporter_1.0.4.tgz(r-4.3-emscripten)
dataReporter.pdf |dataReporter.html✨
dataReporter/json (API)
NEWS

# Install 'dataReporter' in R:

install.packages('dataReporter', repos = c('https://ekstroem.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ekstroem/datareporter/issues

Datasets:

artData - Semi-artificial data about masterpieces of art
bigPresidentData - Semi-artificial data about the US presidents
exampleData - Example data with zero-inflated variables
presidentData - Semi-artificial data about the US presidents
testData - Extended example data to test the features of dataReporter
toyData - Small example data to show the features of dataReporter

On CRAN:

63 exports 85 stars 3.86 score 75 dependencies 32 scripts 384 downloads

Last updated 2 years agofrom:cd8c940cc9. Checks:OK: 1 NOTE: 6. Indexed: yes.

Target	Result	Date
Doc / Vignettes	OK	Sep 15 2024
R-4.5-win	NOTE	Sep 15 2024
R-4.5-linux	NOTE	Sep 15 2024
R-4.4-win	NOTE	Sep 15 2024
R-4.4-mac	NOTE	Sep 15 2024
R-4.3-win	NOTE	Sep 15 2024
R-4.3-mac	NOTE	Sep 15 2024

Exports:allCheckFunctions allClasses allSummaryFunctions allVisualFunctions basicVisual centralValue check checkFunction checkResult classes classes<-countMissing defaultCharacterChecks defaultCharacterSummaries defaultDateChecks defaultDateSummaries defaultFactorChecks defaultFactorSummaries defaultHavenlabelledChecks defaultHavenlabelledSummaries defaultIntegerChecks defaultIntegerSummaries defaultLabelledChecks defaultLabelledSummaries defaultLogicalChecks defaultLogicalSummaries defaultNumericChecks defaultNumericSummaries description description<-identifyCaseIssues identifyLoners identifyMissing identifyNums identifyOutliers identifyOutliersTBStyle identifyWhitespace isCPR isEmpty isKey isSingular isSupported makeCodebook makeDataReport messageGenerator minMax quartiles refCat render setChecks setSummaries setVisuals smartNum standardVisual summarize summaryFunction summaryResult tableVisual uniqueValues variableType visualFunction visualize whoami_available

Dependencies:askpass base64enc bit bit64 bslib cachem cli clipr colorspace cpp11 crayon curl DEoptimR digest evaluate fansi farver fastmap fontawesome forcats fs ggplot2 glue gridExtra gtable haven highr hms htmltools httr isoband jquerylib jsonlite knitr labeling lattice lifecycle magrittr MASS Matrix memoise mgcv mime munsell nlme openssl pander pillar pkgconfig prettyunits progress R6 rappdirs RColorBrewer Rcpp readr rlang rmarkdown robustbase sass scales stringi sys tibble tidyselect tinytex tzdb utf8 vctrs viridisLite vroom whoami withr xfun yaml

Extending dataReporter

Anne Helby Petersen and Claus Thorn Ekstrøm

Rendered fromextending_dataReporter.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2021-11-10
Started: 2020-12-02

Help page	Topics
Overview of all available checkFunctions	allCheckFunctions
Vector of all variable classes in 'dataReporter'	allClasses
Overview of all available summaryFunctions	allSummaryFunctions
Overview of all available visualFunctions	allVisualFunctions
Semi-artificial data about masterpieces of art	artData
Produce distribution plots in the base R (graphics) style using 'plot' and 'barplot'	basicVisual
importFrom stats na.omit	basicVisualCFLB
Semi-artificial data about the US presidents (extended version)	bigPresidentData
summaryFunction for central values	centralValue
Perform checks of potential errors in variable/dataset	check
Create an object of class checkFunction	checkFunction
Create object of class checkResult	checkResult
Extract the contents of the attribute 'classes'	classes classes<-
Summary function for missing values	countMissing
Default checks for character variables	defaultCharacterChecks
Default summary functions for character variables	defaultCharacterSummaries
Default checks for Date variables	defaultDateChecks
Default summary functions for Date variables	defaultDateSummaries
Default checks for factor variables	defaultFactorChecks
Default summary functions for factor variables	defaultFactorSummaries
Default checks for haven_labelled variables	defaultHavenlabelledChecks
Default summary functions for haven_labelled variables	defaultHavenlabelledSummaries
Default checks for integer variables	defaultIntegerChecks
Default summary functions for integer variables	defaultIntegerSummaries
Default checks for labelled variables	defaultLabelledChecks
Default summary functions for labelled variables	defaultLabelledSummaries
Default checks for logical variables	defaultLogicalChecks
Default summary functions for logical variables	defaultLogicalSummaries
Default checks for numeric variables	defaultNumericChecks
Default summary functions for numeric variables	defaultNumericSummaries
Extract the contents of the attribute 'description'	description description<-
Example data with zero-inflated variables	exampleData
A checkFunction for identifying case issues	identifyCaseIssues
A checkFunction for identifying sparsely represented values (loners)	identifyLoners
A checkFunction for identifying miscoded missing values.	identifyMissing
A checkFunction	identifyNums
A checkFunction for identifying outliers	identifyOutliers
A checkFunction for identifying outliers Turkey Boxstole style	identifyOutliersTBStyle
A checkFunction for identifying whitespace	identifyWhitespace
Check if a variable consists of Danish CPR numbers	isCPR
Check if a variable qualifies as a key	isKey
Check if a variable only contains a single value	isEmpty isSingular
Check if a variable has a class supported by dataReporter	isSupported
Produce a data codebook	makeCodebook
Produce a data report	makeDataReport
Produce a message for the output of a checkFunction	messageGenerator
summaryFunction for minimum and maximum	minMax
Semi-artificial data about the US presidents	presidentData
summaryFunction for quartiles	quartiles
summaryFunction that finds reference level for factor variables	refCat
Simplified Rmarkdown rendering	render
Set check arguments for makeDataReport	setChecks
Set summary arguments for makeDataReport	setSummaries
Set visual arguments for makeDataReport	setVisuals
Smart class to handle numerics as factor	smartNum
Produce distribution plots using ggplot from ggplot2.	standardVisual
Summarize a variable/dataset	summarize
Create an object of class summaryFunction	summaryFunction
Create object of class summaryResult	summaryResult
Produce tables for the makeDataReport visualizations.	tableVisual
Extended example data to test the features of dataReporter	testData
Small example data to show the features of dataReporter	toyData
summaryFunction for unique values	uniqueValues
Summary function for original class	variableType
Create an object of class visualFunction	visualFunction
Produce distribution plots	visualize
Find out if the whoami package binaries is installed (git + whoami)	whoami_available

Package: dataReporter 1.0.4

dataReporter: Reproducible Data Screening Checks and Report of Possible Errors

Extending dataReporter

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)