Surveys that have start date/time after system date
Source:R/issurveymadeinthefuture.R
isSurveyMadeInTheFuture.Rd
This function check that all interviews in the dataset do not start after the current date. There is an option to automatically mark for deletion the surveys which have a start date in the future.
Usage
isSurveyMadeInTheFuture(
ds = NULL,
surveyConsent = NULL,
dates = NULL,
reportingColumns = c(enumeratorID, uniquerespondantID),
deleteIsSurveyMadeInTheFuture = FALSE
)
Arguments
- ds
dataset containing the survey (from kobo): labelled 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'))
- reportingColumns
(Optional, by default it is built from the enumeratorID and the uniquerespondantID) name of the columns from the dataset you want in the result: list of string (c('col1','col2',...))
- deleteIsSurveyMadeInTheFuture
(Optional, by default set as FALSE) if TRUE, the survey in error will be marked as 'deletedIsSurveyMadeInTheFuture': boolean (TRUE/FALSE)
- checkperiod
if not null number of day before today when the check should be made
- consentForValidSurvey
value defined in the kobo form to acknowledge the surveyed person gave his consent: string
- uniquerespondantID
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
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")
surveyConsent <- "survey_consent"
uniquerespondantID <- "X_uuid"
enumeratorID <- "enumerator_id"
reportingColumns <- c(enumeratorID, uniquerespondantID)
result <- isSurveyMadeInTheFuture(ds = ds,
surveyConsent=surveyConsent,
dates=dates,
reportingColumns=reportingColumns,
deleteIsSurveyMadeInTheFuture = FALSE)
knitr::kable(head(result[["ret_log"]], 10))
#>
#>
#> | enumerator_id|X_uuid |survey_start |
#> |-------------:|:------|:------------|
print(result[["graph"]])