Compute the average and total time for the surveys

This function compute the average and total time for the surveys 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

Usage

assessmentDuration(ds = NULL, dates = NULL, attempt = NULL)

Arguments

ds

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

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

attempt

name of the field in the dataset where the interview attempt output is stored: string

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
dates <- c("survey_start","end_survey")

result <- assessmentDuration(ds = ds,  dates=dates)
knitr::kable(head(result[["ret_log"]],10))
#> 
#> 
#> |x                                                                                                      |
#> |:------------------------------------------------------------------------------------------------------|
#> |The total time of data collection is 17872.88 minutes and the average time per survey is 35.89 minutes |
print(result[["graph"]])
#> NULL