[doc] rev

unhcr-americas · Apr 26, 2023 · 9d7cea4 · 9d7cea4
1 parent 7567ecd
commit 9d7cea4
Show file tree

Hide file tree

Showing 20 changed files with 114 additions and 124 deletions.
diff --git a/README.md b/README.md
@@ -6,69 +6,36 @@
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 <!-- badges: end -->
 
+`{surveyDesigner}` is a shinyApp to parse a master referential of questions and indicators to generate a contextualized series of [xlsform](http://xlsform.org) questionnaires.
 
-`{surveyDesigner}` is a shinyApp to parse a master XlsForm to generate a contextualized questionnaire.
 
-The app is build using [`{golem}` framework](https://thinkr-open.github.io/golem) and following the tutorial: [Engineering Production-Grade Shiny Apps](https://engineering-shiny.org//).
+For the end-user, aka the Survey Coordinator at Operation level, the application is expected to: 
 
-Read more on the rationale for this app in the [vignette](https://unhcr-americas.github.io/surveyDesigner/docs/articles/surveyDesigner.html)
+  1. Enforce a questionnaire design process that __starts from a selection of indicators__ that needs to be measured and pre-select automatically all the required standardized survey modules and questions in order to measure them. Not only this ensure that standards are actually used, but it will also minimize the risk of questionnaire design mistakes: "_collect what you need, use what you collect_"  
+
+  2. Ease the __contextualization process__ from the global referential to the actual implementation in each country (i.e translating and adjusting the labels as per the specific context) and facilitate the feedback loop so that if the same ad-hoc questions are used in multiple context, they can be considered for inclusion in the global referential 
+
+  3. Support the usage of [mixed-mode (CAPI/CATI?CAWI)](https://www.youtube.com/watch?v=qRmy2OAnyWc) and multiple data collection waves to collect the final dataset within an __annual survey data collection cycle__, all of this allowing both to promote survey integration and to maximize the financial resources invested in those activities  
 
-## Installation
 
-You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with:
+Read more on the rationale for this app in the [vignette](https://unhcr-americas.github.io/surveyDesigner/docs/articles/surveyDesigner.html) or go through the [wiki](https://github.com/unhcr-americas/surveyDesigner/wiki) to go through the technical specifications
 
-``` r
-# install.packages("remotes")
-remotes::install_github("unhcr-americas/surveyDesigner")
-```
 
 ## Run the app  
-This script allows you to display the app
 
-``` r
-# Run the application
-surveyDesigner::run_app()
-```
+The app is still under development - the prototype is accessible here: https://rstudio.unhcr.org/Survey_Designer/ 
 
-## Update the app  
-This script allows you to quickly rebuild and display the app
+To run it locally, use
 
 ``` r
-# Detach all loaded packages and clean your environment
-golem::detach_all_attached()
-
-# rm(list=ls(all.names = TRUE))
-
-# Document and reload your package
-golem::document_and_reload()
-
+# install.packages("remotes")
+remotes::install_github("unhcr-americas/surveyDesigner")
 # Run the application
 surveyDesigner::run_app()
 ```
 
+## For developpers
 
-
-## Update the package documentation
-
-This script allows to update the package documentation
-
-``` r
-devtools::document()
-
-devtools::check(document = FALSE)
-
-pkgdown::build_site()
-```
-
-## As dev :
-
-Please use template commit and MR :
-
-``` r
-project_path <- "path_to_surveyDesigner"
-gert::git_config_set(repo = project_path, name = "commit.template", value = ".github/template_commit")
-```
-
-## Code of Conduct
+The app is build using [`{golem}` framework](https://thinkr-open.github.io/golem) and following the tutorial: [Engineering Production-Grade Shiny Apps](https://engineering-shiny.org//).
 
 Please note that the surveyDesigner project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/class-r6-for-the-referencial.html b/docs/articles/class-r6-for-the-referencial.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/surveyDesigner.html b/docs/articles/surveyDesigner.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,6 +3,7 @@ pkgdown: 2.0.7
 pkgdown_sha: ~
 articles:
   class-r6-for-the-referencial: class-r6-for-the-referencial.html
+  mon-module-home: mon-module-home.html
   surveyDesigner: surveyDesigner.html
-last_built: 2023-04-05T11:55Z
+last_built: 2023-04-26T17:19Z
 
diff --git a/docs/pull_request_template.html b/docs/pull_request_template.html