Merge pull request #17 from unhcr-americas/1-as-dev-i-would-need-to-h…

…ave-an-initial-documented-referential

1 as dev i would need to have an initial documented referential

.Rbuildignore

@@ -10,3 +10,5 @@ $run_dev.*
 ^\.github$
 ^surveyDesigner\.Rproj$
 ^docs$
+^app\.R$
+^rsconnect$

DESCRIPTION

@@ -2,7 +2,7 @@ Package: surveyDesigner
 Title: An Amazing Shiny App
 Version: 0.0.0.9000
 Authors@R: c(
-    person("Edouard", "Legoupil", , "edouard.legoupil@gmail.com", role = c("aut", "cre")),
+    person("Edouard", "Legoupil", , "legoupil@unhcr.org", role = c("aut", "cre")),
     person("Cervan", "Girard", , "cervan@thinkr.fr", role = "aut")
   )
 Description: What the package does (one paragraph).

R/_disable_autoload.R

@@ -0,0 +1,3 @@
+# Disabling shiny autoload
+
+# See ?shiny::loadSupport for more information

R/app_ui.R

@@ -10,7 +10,7 @@ app_ui <- function(request) {
     golem_add_external_resources(),
     # Your application UI logic
     fluidPage(
-      h1("surveyDesignergolem")
+      h1("Survey Designer")
     )
   )
 }
@@ -33,7 +33,7 @@ golem_add_external_resources <- function() {
     favicon(),
     bundle_resources(
       path = app_sys("app/www"),
-      app_title = "surveyDesignergolem"
+      app_title = "surveyDesigner"
     )
     # Add here other external resources
     # for example, you can add shinyalert::useShinyalert()

R/get_groups.R

@@ -4,21 +4,21 @@ survey_designer <- new.env()
 
 assign(
   "names_sheets", 
-  c("survey",
+  c("referential_type",
+    "survey",
     "choices",
-    "Indicator",
-    "Indicator_survey",
-    "indicator_choices", 
+    "indicator",
+    "indicator_survey",
+    "indicator_choices",
     "indicator_population",
-    "indicator_dissagregation", 
-    "country_language"
+    "indicator_disaggregation"
   ), 
   envir = survey_designer)
 
 
 #' Get groups form begin and end into a list with data and information
 #' 
-#' @param data data form the survey sheet
+#' @param data data from the survey sheet
 #'
 #' @importFrom purrr map2 set_names map
 #' @importFrom dplyr slice filter
@@ -62,17 +62,16 @@ by_begin_end <- map2(begin_start, end_stop,
 
 #' Get choices for one question
 #'
-#' @param data data of choices
-#' @param indicator the name of the indicator for the question
-#' @param lg language to use
+#' @param survey data from the choices sheet
+#' @param full_name the full name (i.e. concatenating groups) for the variable
 #'
 #' @importFrom dplyr filter select contains
 #'
 #' @return a data.frame to join
-get_choices_for_question <- function(data, indicator, lg){
-  data %>% 
-    filter(list_name == indicator) %>% 
-    select(list_name, name, contains(lg))
+get_choices_for_question <- function(survey, full_name){
+  survey %>% 
+    filter(list_name == full_name) %>% 
+    select(list_name, name, label)
 }
 
 #' function to find if we manipulate a xlsform
@@ -81,7 +80,8 @@ get_choices_for_question <- function(data, indicator, lg){
 #'
 #' @noRd
 
-is_a_xlsfrom <- function(data){
+
+contains_groups <- function(data){
   any(grepl(x = data[["type"]], pattern = 'begin_group|begin_repeat|end_group|end_repeat'))
 }
 

R/globals.R

@@ -1,6 +1,6 @@
 globalVariables(unique(c(
   # get_choices_for_question:
-  "list_name", "name",
+  "list_name", "name", "label",
   # get_groups:
   ".",
   # get_groups : <anonymous>:

R/referential.R

@@ -9,14 +9,14 @@ Referential <- R6::R6Class(classname = "Referential",
                            public = list(
                              #' @description 
                              #' read the xlsx for each sheet and return a named list
-                             #' @param path path to the xlsForm
+                             #' @param path path to the file with the full referential
                              #' 
                              #' @importFrom readxl excel_sheets read_xlsx
                              #' 
                              #' @return named list
 #' @examples
 #' ref <- Referential$new(
-#'   path = system.file("household_survey_americas.xlsx", package = "surveyDesigner") 
+#'   path = system.file("SurveyDesigner_Referential.xlsx", package = "surveyDesigner") 
 #' )
 #' 
 #' head(ref$data$survey)
@@ -39,8 +39,9 @@ Referential <- R6::R6Class(classname = "Referential",
                                # TODO checking survey and other sheets
 
                                # survey have to be a xlsform
-                               if(!is_a_xlsfrom(data$survey)){
-                                 stop("the sheet 'survey' dosen't seem to be a xlsform")
+
+                               if(!contains_groups(data$survey)){
+                                 stop("the sheet 'survey' doesn't includes groups - i.e. questions organised as module")
                                }
 
                                self$data <- data
@@ -49,9 +50,9 @@ Referential <- R6::R6Class(classname = "Referential",
 
                                self$get_groups()
                              },
-                             #' @field data named list for the xlsx file
+                             #' @field data named list for the referential file
                              data = list(),
-                             #' @field by_groups survey data separate by begin and end to manipulate data
+                             #' @field by_groups survey modules separated by begin and end to manipulate data
                              by_groups = list(),
                              #' @field path path for the xlsx file
                              path  = character(0),

app.R

@@ -0,0 +1,7 @@
+# Launch the ShinyApp (Do not remove this comment)
+# To deploy, run: rsconnect::deployApp()
+# Or use the blue button on top of this file
+
+pkgload::load_all(export_all = FALSE,helpers = FALSE,attach_testthat = FALSE)
+options( "golem.app.prod" = TRUE)
+surveyDesigner::run_app() # add parameters here (if any)

dev/03_deploy.R

@@ -57,3 +57,6 @@ rsconnect::deployApp(
   lint = FALSE,
   forceUpdate = TRUE
 )
+
+library(golem)
+add_rstudioconnect_file(pkg = get_golem_wd(), open = TRUE)

dev/flat_r6_questionnaire.Rmd

@@ -0,0 +1,177 @@
+---
+title: "questionnaire Object"
+output: html_document
+editor_options: 
+  chunk_output_type: console
+---
+
+```{r development, include=FALSE}
+library(testthat)
+```
+
+```{r development-load}
+# Load already included functions if relevant
+pkgload::load_all(export_all = FALSE)
+library(readxl)
+library(dplyr)
+library(purrr)
+
+```
+
+# r6_Questionnaire
+
+
+A questionnaire is created a list of one or multiple [XlsForm](http://xlsform.org)
+
+```{r function-r6_questionnaire}
+#' questionnaire class is a class to load, check and manipulate one or more than one XLSForm 
+#' @importFrom R6 R6Class
+#' 
+#' @export
+
+questionnaire <- R6::R6Class(classname = "questionnaire",
+                           public = list(
+                             #' @description 
+                             #' read the xlsx for each sheet and return a named list
+                             #' @param path path to the xlsForm
+                             #' 
+                             #' @importFrom readxl excel_sheets read_xlsx
+                             #' 
+                             #' @return named list
+                             initialize = function(path){
+                               # Define path
+                               self$path <- path
+                               
+                               # Get sheets of xlsx
+                               sheets <- names_of_sheet(path)
+                               
+                               # Read the xlsx file 
+                               data <- lapply(
+                                 sheets, 
+                                 function(x){
+                                   read_xlsx(path = path, sheet = x)}) |>
+                                      setNames(nm = sheets)
+                               # TODO checking survey and other sheets
+                               
+                               # survey have to be a xlsform
+                               if(!is_a_xlsfrom(data$survey)){
+                                 stop("the sheet 'survey' dosen't seem to be a xlsform")
+                               }
+                               
+                               self$data <- data
+                               
+                               # Get groups 
+                               
+                               self$get_groups()
+                             }
+                           ),
+                           private = list(
+                             
+                           )
+)
+```
+
+```{r development-test}
+ref <- questionnaire$new(
+  path = system.file("household_survey_americas.xlsx", package = "surveyDesigner") 
+)
+```
+
+
+```{r examples-r6_questionnaire}
+ref <- questionnaire$new(
+  path = system.file("household_survey_americas.xlsx", package = "surveyDesigner") 
+)
+
+head(ref$data$survey)
+
+# Example by groups
+ref$by_groups$group_intro
+```
+
+```{r tests-r6_questionnaire}
+test_that("r6_questionnaire works", {
+  ref <- questionnaire$new(
+    path = system.file("household_survey_americas.xlsx", package = "surveyDesigner") 
+  )
+  
+  expect_true( inherits(ref, "R6") )
+  
+  expect_error(
+    questionnaire$new(
+      path = "not_good_sheet.xlsx" 
+    )
+  )
+  
+  expect_error(
+    questionnaire$new(
+      path = "wt_xlsform_in_survey.xlsx" 
+    )
+  )
+
+})
+```
+
+
+# Utils for xlsx
+
+```{r development-utils, eval = FALSE}
+
+
+
+
+```
+
+
+```{r function-utils_xlsform}
+survey_designer <- new.env()
+
+assign(
+  "names_sheets", 
+  c("survey",
+    "choices",
+    "Indicator",
+    "Indicator_survey",
+    "indicator_choices", 
+    "indicator_population",
+    "indicator_dissagregation", 
+    "country_language"
+  ), 
+  envir = survey_designer)
+
+
+
+
+#' function to check name of sheets
+#'
+#' @param path path to the xlsform
+#'
+#' @noRd
+names_of_sheet <- function(path){
+  sheets <- excel_sheets(path)
+  if(all(sheets == get("names_sheets", envir = survey_designer))){
+    return(sheets)
+  }else{
+    stop("Problem with the name of sheets")
+  }
+}
+```
+
+
+```{r tests-utils_xlsform}
+test_that("utils_xlsform works", {
+  
+
+})
+```
+
+
+```{r development-inflate, eval=FALSE}
+# Run but keep eval=FALSE to avoid infinite loop
+# Execute in the console directly
+fusen::inflate(
+  flat_file = "dev/flat_r6_questionnaire.Rmd", 
+  vignette_name = "Class R6 for the questionnaire"
+  )
+```
+