In mabafaba/kobostandards:

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Overview

This packages checks for inconsistencies between xlsform questionnaires (kobo tools), datasets and analysis plans. There is a function to check each input, and to check each combination:

Runs all checks (depending on which input is provided):

check_input()

Which Issues may be raised? - individual inputs

Data

data is not a data.frame (critical)
duplicate data column header (critical)

Questionnaire Questions

questions is not a data frame (critical)
questions do not contain column 'type' (critical)
questions do not contain column 'name' (critical)
illegal question type (critical)
variable [[variable name]] used in 'relevant' column not found in question 'name' (critical)
failed to evaluate 'relevant' condition (critical)
questions do not contain a column with the word 'label' (minor)

Questionnaire Choices

choices is not a data frame (critical)
column missing: 'name' (critical)
column missing: 'list_name' (critical)

Sampling frame

could not check samplingframe (critical)
samplingframe has no categorical column (stratum names) - skipping further checks on stratum column (critical)
samplingframe has more than one categorical column (stratum names) - skipping further checks on stratum column (critical)
samplingframe has no purely numerical (population) column - skipping any further checks on population column (critical)
samplingframe has more than one numerical (population) column (critical)
no stratum can have 0 or negative population (critical)
duplicate stratum name in samplingframe (critical)
samplingframe must not contain NAs (critical)
samplingframe should only have two columns (minor)

Analysis plan

could not check analysisplan - not a data.frame (critical)
could not check analysisplan - 0 rows (critical)
could not check analysisplan standard variables (not a data frame) (critical)
could not find standardised column names in analysis plan (critical)
illegal hypothesis type (critical)
missing required values for analysis plan column: dependent.variable (critical)
missing required values for analysis plan column: independent.variable (critical)

Which Issues may be raised? - inconsistencies between different inputs

Data vs. Questionnaire

could not check data against questionnaire (i.e. koboquest::load_questionnaire() throws an error) (critical)
choices is not a data frame (critical)
data type does not match type defined in questionnaire (critical)
data column not found in questionnaire (minor)
select_one or select_multiple values in data that are not listed in the questionnaire (minor)

Data vs. Analysis Plan

could not check match between data and analysis plan - data is not a data.frame (critical)
could not check match between data and analysis plan - analysisplan is not a data.frame (critical)
analysisplan variable not in data (critical)