Check that the duration relative to the household size of each interview is more than a threshold

This function check that the duration relative to the household size of each interview is more than a specified threshold. There is an option to automatically mark for deletion the surveys which are under the threshold. Warning: If there are uncorrected mistakes in the survey dates, it can lead to have the length of the survey in seconds and this check will not performed well

isInterviewTooShortForTheHouseholdSize(
  ds = NULL,
  surveyConsent = NULL,
  dates = NULL,
  householdSize = NULL,
  minimumSurveyDurationByIndividual = 10,
  reportingColumns = c(enumeratorID, uniqueID),
  deleteIsInterviewTooShortForTheHouseholdSize = FALSE
)

Arguments

ds	dataset containing the survey (from kobo): data.frame
surveyConsent	name of the field in the dataset where the survey consent is stored: string
dates	name of the fields where the information about the start and end date of the survey is stored: list of string (c('start_date','end_date'))
householdSize	name of the field in the dataset where the household size is stored: string
minimumSurveyDurationByIndividual	minimum acceptable survey duration for one individual in minutes: integer
reportingColumns	(Optional, by default it is built from the enumeratorID and the UniqueID) name of the columns from the dataset you want in the result: list of string (c('col1','col2',...))
deleteIsInterviewTooShortForTheHouseholdSize	(Optional, by default set as FALSE) if TRUE, the survey in error will be marked as 'deletedIsInterviewTooShortForTheHouseholdSize': boolean (TRUE/FALSE)
uniqueID	name of the field where the survey unique ID is stored: string
enumeratorID	name of the field where the enumerator ID is stored: string

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

Yannick Pascaud

Examples

{
ds <- HighFrequencyChecks::sample_dataset
surveyConsent <- "survey_consent"
dates <- c("survey_start","end_survey")
householdSize <-"consent_received.respondent_info.hh_size"
uniqueID <- "X_uuid"
enumeratorID <- "enumerator_id"
minimumSurveyDurationByIndividual <- 10
reportingColumns <- c(enumeratorID, uniqueID)

list[dst,ret_log,var,graph] <- isInterviewTooShortForTheHouseholdSize(ds=ds,
                           surveyConsent=surveyConsent,
                           dates=dates,
                           householdSize=householdSize,
                           minimumSurveyDurationByIndividual=minimumSurveyDurationByIndividual,
                           reportingColumns=reportingColumns,
                           deleteIsInterviewTooShortForTheHouseholdSize=FALSE)
head(ret_log, 10)
print(graph)
}