surveyOtherValues: List of other distinct values (not missing) per fields other...

Description Usage Arguments Value Author(s) Examples

Description

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

1
2
3
4
5
6
surveyOtherValues(
  ds = NULL,
  otherPattern = NULL,
  enumeratorID = NULL,
  enumeratorCheck = FALSE
)

Arguments

ds

dataset containing the survey (from kobo): 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)

Value

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)

Author(s)

Yannick Pascaud

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
ds <- HighFrequencyChecks::sample_dataset
otherPattern <- "_other$"
enumeratorID <- "enumerator_id"

list[dst,ret_log,var,graph] <- surveyOtherValues(ds=ds,
                                                 otherPattern=otherPattern,
                                                 enumeratorID=enumeratorID,
                                                 enumeratorCheck=FALSE)
head(ret_log,10)
}

PYannick/HighFrequencyChecks documentation built on Dec. 31, 2020, 3:26 p.m.