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'))

Peer review:

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:

6.16 score 86 stars 34 scripts 313 downloads 63 exports 75 dependencies

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

TargetResultDate
Doc / VignettesOKNov 14 2024
R-4.5-winNOTENov 14 2024
R-4.5-linuxNOTENov 14 2024
R-4.4-winNOTENov 14 2024
R-4.4-macNOTENov 14 2024
R-4.3-winNOTENov 14 2024
R-4.3-macNOTENov 14 2024

Exports:allCheckFunctionsallClassesallSummaryFunctionsallVisualFunctionsbasicVisualcentralValuecheckcheckFunctioncheckResultclassesclasses<-countMissingdefaultCharacterChecksdefaultCharacterSummariesdefaultDateChecksdefaultDateSummariesdefaultFactorChecksdefaultFactorSummariesdefaultHavenlabelledChecksdefaultHavenlabelledSummariesdefaultIntegerChecksdefaultIntegerSummariesdefaultLabelledChecksdefaultLabelledSummariesdefaultLogicalChecksdefaultLogicalSummariesdefaultNumericChecksdefaultNumericSummariesdescriptiondescription<-identifyCaseIssuesidentifyLonersidentifyMissingidentifyNumsidentifyOutliersidentifyOutliersTBStyleidentifyWhitespaceisCPRisEmptyisKeyisSingularisSupportedmakeCodebookmakeDataReportmessageGeneratorminMaxquartilesrefCatrendersetCheckssetSummariessetVisualssmartNumstandardVisualsummarizesummaryFunctionsummaryResulttableVisualuniqueValuesvariableTypevisualFunctionvisualizewhoami_available

Dependencies:askpassbase64encbitbit64bslibcachemclicliprcolorspacecpp11crayoncurlDEoptimRdigestevaluatefansifarverfastmapfontawesomeforcatsfsggplot2gluegridExtragtablehavenhighrhmshtmltoolshttrisobandjquerylibjsonliteknitrlabelinglatticelifecyclemagrittrMASSMatrixmemoisemgcvmimemunsellnlmeopensslpanderpillarpkgconfigprettyunitsprogressR6rappdirsRColorBrewerRcppreadrrlangrmarkdownrobustbasesassscalesstringisystibbletidyselecttinytextzdbutf8vctrsviridisLitevroomwhoamiwithrxfunyaml

Extending dataReporter

Anne Helby Petersen and Claus Thorn Ekstrøm

Rendered fromextending_dataReporter.Rmdusingknitr::rmarkdownon Nov 14 2024.

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

Readme and manuals

Help Manual

Help pageTopics
Overview of all available checkFunctionsallCheckFunctions
Vector of all variable classes in 'dataReporter'allClasses
Overview of all available summaryFunctionsallSummaryFunctions
Overview of all available visualFunctionsallVisualFunctions
Semi-artificial data about masterpieces of artartData
Produce distribution plots in the base R (graphics) style using 'plot' and 'barplot'basicVisual
importFrom stats na.omitbasicVisualCFLB
Semi-artificial data about the US presidents (extended version)bigPresidentData
summaryFunction for central valuescentralValue
Perform checks of potential errors in variable/datasetcheck
Create an object of class checkFunctioncheckFunction
Create object of class checkResultcheckResult
Extract the contents of the attribute 'classes'classes classes<-
Summary function for missing valuescountMissing
Default checks for character variablesdefaultCharacterChecks
Default summary functions for character variablesdefaultCharacterSummaries
Default checks for Date variablesdefaultDateChecks
Default summary functions for Date variablesdefaultDateSummaries
Default checks for factor variablesdefaultFactorChecks
Default summary functions for factor variablesdefaultFactorSummaries
Default checks for haven_labelled variablesdefaultHavenlabelledChecks
Default summary functions for haven_labelled variablesdefaultHavenlabelledSummaries
Default checks for integer variablesdefaultIntegerChecks
Default summary functions for integer variablesdefaultIntegerSummaries
Default checks for labelled variablesdefaultLabelledChecks
Default summary functions for labelled variablesdefaultLabelledSummaries
Default checks for logical variablesdefaultLogicalChecks
Default summary functions for logical variablesdefaultLogicalSummaries
Default checks for numeric variablesdefaultNumericChecks
Default summary functions for numeric variablesdefaultNumericSummaries
Extract the contents of the attribute 'description'description description<-
Example data with zero-inflated variablesexampleData
A checkFunction for identifying case issuesidentifyCaseIssues
A checkFunction for identifying sparsely represented values (loners)identifyLoners
A checkFunction for identifying miscoded missing values.identifyMissing
A checkFunctionidentifyNums
A checkFunction for identifying outliersidentifyOutliers
A checkFunction for identifying outliers Turkey Boxstole styleidentifyOutliersTBStyle
A checkFunction for identifying whitespaceidentifyWhitespace
Check if a variable consists of Danish CPR numbersisCPR
Check if a variable qualifies as a keyisKey
Check if a variable only contains a single valueisEmpty isSingular
Check if a variable has a class supported by dataReporterisSupported
Produce a data codebookmakeCodebook
Produce a data reportmakeDataReport
Produce a message for the output of a checkFunctionmessageGenerator
summaryFunction for minimum and maximumminMax
Semi-artificial data about the US presidentspresidentData
summaryFunction for quartilesquartiles
summaryFunction that finds reference level for factor variablesrefCat
Simplified Rmarkdown renderingrender
Set check arguments for makeDataReportsetChecks
Set summary arguments for makeDataReportsetSummaries
Set visual arguments for makeDataReportsetVisuals
Smart class to handle numerics as factorsmartNum
Produce distribution plots using ggplot from ggplot2.standardVisual
Summarize a variable/datasetsummarize
Create an object of class summaryFunctionsummaryFunction
Create object of class summaryResultsummaryResult
Produce tables for the makeDataReport visualizations.tableVisual
Extended example data to test the features of dataReportertestData
Small example data to show the features of dataReportertoyData
summaryFunction for unique valuesuniqueValues
Summary function for original classvariableType
Create an object of class visualFunctionvisualFunction
Produce distribution plotsvisualize
Find out if the whoami package binaries is installed (git + whoami)whoami_available