Report the percentage of missing values (NA) per fields

This function provide a report showing the percentage of missing values (NA) for each fields. This report can be global (all the surveys) or displayed for each enumerator ID

Usage

surveyMissingValues(ds = NULL, enumeratorID = NULL, enumeratorCheck = FALSE)

Arguments

ds

dataset containing the survey (from kobo): labelled data.frame

enumeratorID

name of the field where the enumerator ID is stored: string

enumeratorCheck

(Optional, by default set to FALSE) specify if the report has to be displayed for each enumerator or not: boolean (TRUE/FALSE)

checkperiod

if not null number of day before today when the check should be made

surveyConsent

name of the field in the dataset where the survey consent is stored: string

consentForValidSurvey

value defined in the kobo form to acknowledge the surveyed person gave his consent: string

Value

result a list that includes: * dst same dataset as the inputed one but with survey marked for deletion if errors are found and delete=TRUE (or NULL) * ret_log list of the errors found (or NULL) * var a list of value (or NULL) * graph graphical representation of the results (or NULL)

Examples

load(system.file("sample_dataset.RData", package = "HighFrequencyChecks")) 
ds <- sample_dataset
enumeratorID <- "enumerator_id"

result <- surveyMissingValues(ds = ds,
                                                    enumeratorID=enumeratorID,
                                                    enumeratorCheck=FALSE)
knitr::kable(head(result[["ret_log"]], 10))  
#> 
#> 
#> |                 |variables        | pct|
#> |:----------------|:----------------|---:|
#> |X.5              |X.5              |   0|
#> |instance_name    |instance_name    |   0|
#> |survey_date      |survey_date      |   0|
#> |survey_start     |survey_start     |   0|
#> |enumerator_org   |enumerator_org   |   0|
#> |enumerator_id    |enumerator_id    |   0|
#> |upazilla_name    |upazilla_name    |   0|
#> |union_name       |union_name       |   0|
#> |informed_consent |informed_consent | 100|
#> |survey_consent   |survey_consent   |   0|