From 9d7cea484a70919a2b71cb1b7f1b37326a5b49a3 Mon Sep 17 00:00:00 2001 From: Edouard Date: Wed, 26 Apr 2023 12:40:21 -0500 Subject: [PATCH 1/2] [doc] rev --- README.md | 61 ++++------------- docs/404.html | 3 + docs/CODE_OF_CONDUCT.html | 3 + docs/LICENSE-text.html | 3 + docs/LICENSE.html | 3 + .../class-r6-for-the-referencial.html | 3 + docs/articles/index.html | 5 ++ docs/articles/surveyDesigner.html | 3 + docs/authors.html | 3 + docs/index.html | 65 +++++-------------- docs/news/index.html | 3 + docs/pkgdown.yml | 3 +- docs/pull_request_template.html | 27 ++++---- docs/reference/Referential.html | 3 + docs/reference/get_choices_for_question.html | 3 + docs/reference/get_groups.html | 3 + docs/reference/index.html | 11 ++-- docs/reference/pipe.html | 3 + docs/reference/run_app.html | 5 +- docs/sitemap.xml | 25 +++---- 20 files changed, 114 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index 3734547..6f1d803 100644 --- 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) +`{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 index 5826594..1839362 100644 --- a/docs/404.html +++ b/docs/404.html @@ -54,6 +54,9 @@
  • Class R6 for the referencial
    • +
  • + Mon module home +
  • diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 0bc2f20..73ba2bc 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -37,6 +37,9 @@
  • Changelog diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 5095fb9..5747929 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -37,6 +37,9 @@
  • Changelog diff --git a/docs/LICENSE.html b/docs/LICENSE.html index cd3c7f1..f576d14 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -37,6 +37,9 @@
  • Changelog diff --git a/docs/articles/class-r6-for-the-referencial.html b/docs/articles/class-r6-for-the-referencial.html index ab794be..684d623 100644 --- a/docs/articles/class-r6-for-the-referencial.html +++ b/docs/articles/class-r6-for-the-referencial.html @@ -55,6 +55,9 @@
  • Class R6 for the referencial
    • +
  • + Mon module home +
  • diff --git a/docs/articles/index.html b/docs/articles/index.html index 39ac7de..ba7fc79 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -37,6 +37,9 @@
  • Changelog @@ -58,6 +61,8 @@

    All vignettes

    Class R6 for the referencial
    +
    +
    Mon module home
    surveyDesigner
    diff --git a/docs/articles/surveyDesigner.html b/docs/articles/surveyDesigner.html index 05ae8e9..2d8da50 100644 --- a/docs/articles/surveyDesigner.html +++ b/docs/articles/surveyDesigner.html @@ -55,6 +55,9 @@
  • Class R6 for the referencial
    • +
  • + Mon module home +
  • diff --git a/docs/authors.html b/docs/authors.html index ed1a3f8..2d05d55 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -37,6 +37,9 @@
  • Changelog diff --git a/docs/index.html b/docs/index.html index 2ae5b38..1151854 100644 --- a/docs/index.html +++ b/docs/index.html @@ -55,6 +55,9 @@
  • Class R6 for the referencial
    • +
  • + Mon module home +
  • @@ -78,63 +81,29 @@ -

    {surveyDesigner} is a shinyApp to parse a master XlsForm to generate a contextualized questionnaire.

    -

    The app is build using {golem} framework and following the tutorial: Engineering Production-Grade Shiny Apps.

    -

    Read more on the rationale for this app in the vignette

    +

    {surveyDesigner} is a shinyApp to parse a master referential of questions and indicators to generate a contextualized series of xlsform questionnaires.

    +

    For the end-user, aka the Survey Coordinator at Operation level, the application is expected to:

    +
      +

    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. +

    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. +

    3. Support the usage of mixed-mode (CAPI/CATI?CAWI) 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

      4. +
    +

    Read more on the rationale for this app in the vignette or go through the wiki to go through the technical specifications

    -

    Installation +

    Run the app

    -

    You can install the development version from GitHub with:

    +

    The app is still under development - the prototype is accessible here: https://rstudio.unhcr.org/Survey_Designer/

    +

    To run it locally, use

     # install.packages("remotes")
-remotes::install_github("unhcr-americas/surveyDesigner")
    -
    -
    -

    Run the app -

    -

    This script allows you to display the app

    -
    -# Run the application
-surveyDesigner::run_app()
    -
    -
    -

    Update the app -

    -

    This script allows you to quickly rebuild and display the app

    -
    -# 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()
-
+remotes::install_github("unhcr-americas/surveyDesigner")
 # Run the application
 surveyDesigner::run_app()
    -

    Update the package documentation -

    -

    This script allows to update the package documentation

    -
    -devtools::document()
-
-devtools::check(document = FALSE)
-
-pkgdown::build_site()
    -
    -
    -

    As dev : -

    -

    Please use template commit and MR :

    -
    -project_path <- "path_to_surveyDesigner"
-gert::git_config_set(repo = project_path, name = "commit.template", value = ".github/template_commit")
    -
    -
    -

    Code of Conduct +

    For developpers

    +

    The app is build using {golem} framework and following the tutorial: Engineering Production-Grade Shiny Apps.

    Please note that the surveyDesigner project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

    diff --git a/docs/news/index.html b/docs/news/index.html index 8496806..09b87a2 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -37,6 +37,9 @@
  • Changelog diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index dd9e94f..5e9d84d 100644 --- 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 index bc826bf..1763626 100644 --- a/docs/pull_request_template.html +++ b/docs/pull_request_template.html @@ -37,6 +37,9 @@
  • Changelog @@ -54,35 +57,35 @@

    NA

    -