Dev

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: impactR.analysis
 Title: Analyzing survey data (collected with Kobo)
-Version: 0.0.3
+Version: 0.0.4
 Authors@R: c(
      person("Noblet", "Guillaume", email = "[email protected]", role = c("aut", "cre"))
   )

NAMESPACE

@@ -4,6 +4,7 @@ export(auto_kobo_analysis)
 export(auto_svy_analysis)
 export(kobo_analysis)
 export(kobo_analysis_from_dap)
+export(kobo_analysis_from_dap_group)
 export(kobo_mean)
 export(kobo_mean_all)
 export(kobo_median)

NEWS.md

@@ -1,3 +1,9 @@
+# impactR.analysis 0.0.4
+
+* Update: the default choices_sep is now "/".
+* Update: analysis key has been updated (see #11).
+* New: `kobo_analysis_from_dap_group()` is a wrapper around the `kobo_analysis_from_dap()` function, over a list of grouping vectors (#15).
+
 # impactR.analysis 0.0.3
 
 * Breaking change and new: the `kobo_*()` family functions make use of the `svy_*()` family and Kobo tools. Previous functions have been renamed and updated `prop_*`.

R/auto_kobo_analysis.R

@@ -22,7 +22,8 @@
 #'
 #' @export
 #'
-auto_kobo_analysis <- function(design, survey, choices, group = NULL, group_key_sep = " -/- ", na_rm = TRUE, vartype = "ci", level = 0.95, choices_sep = "_", label_survey = TRUE, bind = TRUE){
+auto_kobo_analysis <- function(design, survey, choices, group = NULL, group_key_sep = " -/- ", na_rm = TRUE, vartype = "ci", level = 0.95, choices_sep = "/", label_survey = TRUE, bind = TRUE){
+
 
   num_median_an <- kobo_median_all(design, survey, group, group_key_sep, label_survey, na_rm, vartype, level)
   num_mean_an <- kobo_mean_all(design, survey, group, group_key_sep, label_survey, na_rm, vartype, level)

R/kobo_analysis.R

@@ -26,7 +26,7 @@
 #'
 #' @export
 #'
-kobo_analysis <- function(design, analysis, vars, survey, choices = NULL, group = NULL, group_key_sep = " -/- ", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95, ratio_key_sep = " -/- ",  choices_sep = "_"){
+kobo_analysis <- function(design, analysis, vars, survey, choices = NULL, group = NULL, group_key_sep = " -/- ", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95, ratio_key_sep = " -/- ",  choices_sep = "/"){
 
 
   analysis_type <- c("mean", "median", "select_multiple", "select_one", "ratio")

R/kobo_analysis_from_dap.R

@@ -1,4 +1,6 @@
-#' @title Kobo survey analysis from a data analysis plan
+#' Kobo survey analysis from a data analysis plan
+#'
+#' [kobo_analysis_from_dap] performs a survey analysis from a data analysis plan, while [kobo_analysis_from_dap_group] is a wrapper around the former to run multiple grouped analyses at once.
 #'
 #' @param design A srvyr::design object.
 #' @param dap A well formatted data analysis plan.#'
@@ -21,7 +23,7 @@
 #'
 #' @export
 #'
-kobo_analysis_from_dap <- function(design, dap, survey, choices, group = NULL, level = 0.95, choices_sep = "_"){
+kobo_analysis_from_dap <- function(design, dap, survey, choices, group = NULL, level = 0.95, choices_sep = "/"){
 
   #------ Checks
 
@@ -77,6 +79,48 @@ kobo_analysis_from_dap <- function(design, dap, survey, choices, group = NULL, l
 
 
   return(analysis)
-#
 
 }
+
+
+
+#' @rdname kobo_analysis_from_dap
+#'
+#' @param l_group A list of vectors of variables to group by.
+#' @param no_group If TRUE, the analysis without grouping is run.
+#'
+#' @export
+kobo_analysis_from_dap_group <- function(design, dap, survey, choices, l_group, no_group = TRUE, level = 0.95, choices_sep = "/"){
+
+  #------ Checks
+
+  # Check if l_group is a list
+  if (!is.list(l_group)) rlang::abort("'l_group' should be a list.")
+
+  # Check if all elements are vectors of variables that exist in the design
+  purrr::map(l_group, \(x) if_not_in_stop(design$variables, x, "design"))
+
+  #------ Run analysis
+
+  # Map over group list
+  analysis <- purrr::map(
+    l_group,
+    \(x) {
+
+      an <- kobo_analysis_from_dap(design = design, dap = dap, survey = survey, choices = choices, group = x, level = level, choices_sep = choices_sep)
+
+      return(an)
+
+    },
+    .progress = TRUE
+  )
+
+  if(no_group) analysis[["no_grouping"]] <- kobo_analysis_from_dap(design = design, dap = dap, survey = survey, choices = choices, level = level, choices_sep = choices_sep)
+
+  # Bind all analyses together
+  analysis <- purrr::list_rbind(analysis)
+
+
+  return(analysis)
+}
+

R/kobo_ratio.R

@@ -14,7 +14,7 @@
 #' @return A character vector of select_one questions.
 #'
 #' @export
-kobo_ratio <- function(design, nums, denoms, ratio_key_sep = " -/- ", survey, group = NULL, group_key_sep = " ~/~ ", label_survey = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
+kobo_ratio <- function(design, nums, denoms, ratio_key_sep = " -/- ", survey, group = NULL, group_key_sep = " -/- ", label_survey = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
 
 
   #------ Gather arguments

R/kobo_select_multiple.R

@@ -27,7 +27,7 @@
 #' @return A character vector of select_one questions.
 #'
 #' @export
-kobo_select_multiple <- function(design, vars, survey, choices = NULL, choices_sep = "_", group = NULL, group_key_sep = " -/- ", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
+kobo_select_multiple <- function(design, vars, survey, choices = NULL, choices_sep = "/", group = NULL, group_key_sep = " -/- ", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
 
   #------ Check
 

R/kobo_select_multiple_all.R

@@ -17,7 +17,7 @@
 #' @return A character vector of select_one questions.
 #'
 #' @export
-kobo_select_multiple_all <- function(design, survey, choices, group = NULL, group_key_sep = " -/- ", choices_sep = "_", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
+kobo_select_multiple_all <- function(design, survey, choices, group = NULL, group_key_sep = " -/- ", choices_sep = "/", label_survey = TRUE, label_choices = TRUE, na_rm = TRUE, vartype = "ci", level = 0.95){
 
   select_multiples <- impactR.kobo::get_survey_select_multiple(survey)
 

R/svy_analysis.R

@@ -27,7 +27,7 @@
 #'
 #' @export
 #'
-svy_analysis <- function(design, analysis, vars, group = NULL, group_key_sep = " -/- ", na_rm = TRUE, vartype = "ci", level = 0.95, ratio_key_sep = " ~/~ ",  interact_key_sep = " -/- ", quantiles = c(0.25, 0.5, 0.75), ak = TRUE, ak_overall_sep = " @/@ ", ak_main_sep = " -/-", ak_var_to_value_sep = " %/% ", ...){
+svy_analysis <- function(design, analysis, vars, group = NULL, group_key_sep = " -/- ", na_rm = TRUE, vartype = "ci", level = 0.95, ratio_key_sep = " -/- ",  interact_key_sep = " -/- ", quantiles = c(0.25, 0.5, 0.75), ak = TRUE, ak_overall_sep = " @/@ ", ak_main_sep = " -/-", ak_var_to_value_sep = " %/% ", ...){
 
 
   analysis_type <- c("mean", "median", "proportion", "quantile", "ratio", "interact")

vignettes/kobo_analysis.Rmd

@@ -88,6 +88,7 @@ The `auto_kobo_analysis()` function runs all the above functions but `kobo_ratio
 While all these functions provide a quick workflow for analyzing survey data, the recommend way is to provide a data analysis plan and use functions `kobo_analysis()` or `kobo_analysis_dap()` (see below), which allows for finer analyses (e.g. providing ratios, labels of indicators, etc., beyond types as defined in the Kobo tool.)
 
 ## Make your own analysis 
+
 ```{r kobo-analysis, eval = F}
 # Calculate a mean
 kobo_analysis(design, analysis = "mean", vars = c("c_total_3_17_femmes", "e_abandont_3a_4a_fille"), survey)
@@ -126,10 +127,10 @@ Then, to run the analysis, do the following:
 
 ```{r kobo-analysis-from-dap, eval = F}
 # Default
-kobo_analysis_from_dap(design, analysis_dap, survey, choices)
+kobo_analysis_from_dap(design, analysis_dap, survey, choices, choices_sep = "_")
 
 # Grouped and confidence level of 0.99
-kobo_analysis_from_dap(design, analysis_dap, survey, choices, group = "milieu", level = 0.99)
+kobo_analysis_from_dap(design, analysis_dap, survey, choices, group = "milieu", level = 0.99, choices_sep = "_")
 
 ```