| Title: | What the Package Does (Title Case) |
|---|---|
| Description: | More about what it does (maybe more than one line) Use four spaces when indenting paragraphs within the Description. |
| Authors: | Who wrote it |
| Maintainer: | The package maintainer <[email protected]> |
| License: | GPL-3 |
| Version: | 0.1.0.9000 |
| Built: | 2024-09-24 03:43:26 UTC |
| Source: | https://github.com/mabafaba/kobostandards |
adding issues together
add_issues(x) <- valueadd_issues(x) <- value
# use me like you'd use `names()`: add_issues(existing_list_of_issues)<-another_list_of_issues # is equivalent to: existing_list_of_issues<-rbind(existing_df_with_issues,another_df_with_issues)# use me like you'd use `names()`: add_issues(existing_list_of_issues)<-another_list_of_issues # is equivalent to: existing_list_of_issues<-rbind(existing_df_with_issues,another_df_with_issues)
Check if Assessment files are in order
check_input(data = NULL, questions = NULL, choices = NULL, samplingframe = NULL, analysisplan = NULL)check_input(data = NULL, questions = NULL, choices = NULL, samplingframe = NULL, analysisplan = NULL)
data |
the dataset ( from load_data() ) |
samplingframe |
the samplingframe ( from load_samplingframe() ) |
questionnaire |
the questionnaire ( from load_questionnaire() ) |
check analysisplan (this one is for analysisplan inputs to the hypegrammaR package specifically)
check_input_analysisplan(analysisplan)check_input_analysisplan(analysisplan)
analysisplan |
the analysisplan as a data.frame |
list of issues (see ?new_issues() for details)
Check if data format is good
check_input_data(data)check_input_data(data)
data |
data as data frame |
data frame with issues (see 'new_issues()' for details)
Check for inconsistencies between an xlsform questionnaire and a dataset
check_input_match_data_questionnaire(data, questions, choices)check_input_match_data_questionnaire(data, questions, choices)
data |
dataset as data.frame |
xlsform |
questions sheet as data.frame |
xlsform |
choices sheet as data.frame |
Check if questionnaire format is good
check_input_questionnaire(questions, choices)check_input_questionnaire(questions, choices)
questions |
kobo questions sheet as data frame |
choices |
kobo choices sheet as data frame |
data frame with issues (see 'new_issues()' for details)
check sampling frame data structure
check_input_samplingframe(samplingframe)check_input_samplingframe(samplingframe)
list of issues (see ?new_issues() for details)
all parameters except 'issue' are optional each paramter must be a vector, they all must have the same length length 'severity' must be one of the predefined levels
new_issues(issue = character(0), affected_files = character(length(issue)), affected_variables = character(length(issue)), severity = factor(length(issue), levels = c("minor", "problematic", "critical")), comment = character(length(issue)))new_issues(issue = character(0), affected_files = character(length(issue)), affected_variables = character(length(issue)), severity = factor(length(issue), levels = c("minor", "problematic", "critical")), comment = character(length(issue)))