List of other distinct values (not missing) per fields other with count
Source:R/surveyothervalues.R
surveyOtherValues.Rd
This function provide a report showing all distinct other values and the number of occurrences for each fields "other". This report can be global (all the surveys) or displayed for each enumerator ID
Usage
surveyOtherValues(
ds = NULL,
otherPattern = NULL,
enumeratorID = NULL,
enumeratorCheck = FALSE
)
Arguments
- ds
dataset containing the survey (from kobo): labelled data.frame
- otherPattern
patternto identify the fields containing others values (eg: '_other$'): string
- 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
otherPattern <- "_other"
enumeratorID <- "enumerator_id"
result <- surveyOtherValues(ds = ds,
otherPattern=otherPattern,
enumeratorID=enumeratorID,
enumeratorCheck=FALSE)
knitr::kable(head(result[["ret_log"]], 10))
#>
#>
#>