From 32aec275bb1672bced3e45a2cff04713132cd4b6 Mon Sep 17 00:00:00 2001 From: Edouard Date: Wed, 26 Apr 2023 12:56:41 -0500 Subject: [PATCH] [doc] update the prez --- README.md | 1 + docs/404.html | 5 +- docs/CODE_OF_CONDUCT.html | 5 +- docs/LICENSE-text.html | 5 +- docs/LICENSE.html | 5 +- .../class-r6-for-the-referential.html | 192 ++++++++++++++++++ docs/articles/index.html | 9 +- docs/articles/surveyDesigner.html | 5 +- docs/authors.html | 5 +- docs/index.html | 6 +- docs/news/index.html | 5 +- docs/pkgdown.yml | 5 +- docs/pull_request_template.html | 5 +- docs/reference/Referential.html | 99 ++++----- docs/reference/get_choices_for_question.html | 19 +- docs/reference/get_groups.html | 7 +- docs/reference/index.html | 5 +- docs/reference/pipe.html | 5 +- docs/reference/run_app.html | 5 +- docs/sitemap.xml | 3 + 20 files changed, 273 insertions(+), 123 deletions(-) create mode 100644 docs/articles/class-r6-for-the-referential.html diff --git a/README.md b/README.md index 6f1d803..f770c22 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ For the end-user, aka the Survey Coordinator at Operation level, the application 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 +Overall, this will contribute over time to the creation of [standardized survey-based indicators](https://egrisstats.org/resource/data-disaggregation-of-sdg-indicators-by-forced-displacement/) for comparative data analysis across countries and contexts. 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 diff --git a/docs/404.html b/docs/404.html index 1839362..b8e9bba 100644 --- a/docs/404.html +++ b/docs/404.html @@ -52,10 +52,7 @@ diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 73ba2bc..5e3bbad 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -35,10 +35,7 @@
  • diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 5747929..68f68d8 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -35,10 +35,7 @@
  • diff --git a/docs/LICENSE.html b/docs/LICENSE.html index f576d14..fc19b0c 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -35,10 +35,7 @@
  • diff --git a/docs/articles/class-r6-for-the-referential.html b/docs/articles/class-r6-for-the-referential.html new file mode 100644 index 0000000..6526435 --- /dev/null +++ b/docs/articles/class-r6-for-the-referential.html @@ -0,0 +1,192 @@ + + + + + + + +Class R6 for the referential • surveyDesigner + + + + + + + + + + + + +
    +
    + + + + +
    +
    +
    +

    Class R6 for the referential

    + + + + + +
    + + + +
    +library(surveyDesigner)
    + +
    +

    r6_referential +

    +

    The filtering of the referential should take in account the +order/sequence of questions and modules.

    +

    A specific method is implemented to separate our file with begin and +end group

    +
    +ref <- Referential$new(
+  path = system.file("SurveyDesigner_Referential.xlsx", package = "surveyDesigner") 
+)
+#> New names:
+#> result is store in `by_groups` sub-element
+#> • `` -> `...14`
+
+head(ref$data$survey)
+#> # A tibble: 6 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey start  start NA    NA    NA       NA               NA        
+#> 2 household_survey end    end   NA    NA    NA       NA               NA        
+#> 3 household_survey calcu… star… NA    NA    NA       NA               NA        
+#> 4 household_survey calcu… end_t NA    NA    NA       NA               NA        
+#> 5 household_survey calcu… time… Time… NA    NA       NA               NA        
+#> 6 household_survey calcu… time… Time… NA    NA       NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
+
+# Example by groups
+ref$by_groups$group_intro
+#> $data
+#> # A tibble: 6 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey date   inte… Plea… NA    false    NA               NA        
+#> 2 household_survey selec… Bure… Plea… Read… true     NA               NA        
+#> 3 household_survey selec… Coun… Plea… Read… true     NA               NA        
+#> 4 household_survey calcu… coun… NA    NA    false    NA               NA        
+#> 5 household_survey geopo… geop… Reco… NA    false    NA               NA        
+#> 6 household_survey selec… pop_… Plea… Read… true     NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
+#> 
+#> $information
+#> # A tibble: 2 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey begin… grou… Inte… NA    false    NA               NA        
+#> 2 household_survey end_g… NA    NA    NA    NA       NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
    +
    +
    +

    Utils for referential manipulation +

    +
    +
    + + + +
    + + + +
    +

    +

    Developed by Edouard Legoupil, Cervan Girard.

    +
    + +
    +

    +

    Site built with pkgdown 2.0.7.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/articles/index.html b/docs/articles/index.html index ba7fc79..594ec9c 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -35,10 +35,7 @@
  • @@ -60,9 +57,7 @@

    Articles

    All vignettes

    -
    Class R6 for the referencial
    -
    -
    Mon module home
    +
    Class R6 for the referential
    surveyDesigner
    diff --git a/docs/articles/surveyDesigner.html b/docs/articles/surveyDesigner.html index 2d8da50..9881553 100644 --- a/docs/articles/surveyDesigner.html +++ b/docs/articles/surveyDesigner.html @@ -53,10 +53,7 @@
    • diff --git a/docs/authors.html b/docs/authors.html index 2d05d55..43c3766 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -35,10 +35,7 @@
  • diff --git a/docs/index.html b/docs/index.html index 1151854..46903f3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -53,10 +53,7 @@
    • @@ -88,6 +85,7 @@

  • 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

  • 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

    • +

    Overall, this will contribute over time to the creation of standardized survey-based indicators for comparative data analysis across countries and contexts.

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

    Run the app diff --git a/docs/news/index.html b/docs/news/index.html index 09b87a2..f938659 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -35,10 +35,7 @@
  • diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 5e9d84d..8006c3e 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,8 +2,7 @@ pandoc: 2.19.2 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 + class-r6-for-the-referential: class-r6-for-the-referential.html surveyDesigner: surveyDesigner.html -last_built: 2023-04-26T17:19Z +last_built: 2023-04-26T17:55Z diff --git a/docs/pull_request_template.html b/docs/pull_request_template.html index 1763626..51b90e7 100644 --- a/docs/pull_request_template.html +++ b/docs/pull_request_template.html @@ -35,10 +35,7 @@
  • diff --git a/docs/reference/Referential.html b/docs/reference/Referential.html index 73d612d..6af076a 100644 --- a/docs/reference/Referential.html +++ b/docs/reference/Referential.html @@ -36,10 +36,7 @@
  • @@ -68,11 +65,11 @@

    Referential class is a class to load, check and manipulate the XLSForm

    Public fields

    data
    -

    named list for the xlsx file

    +

    named list for the referential file

    by_groups
    -

    survey data separate by begin and end to manipulate data

    +

    survey modules separated by begin and end to manipulate data

    path
    @@ -100,7 +97,7 @@

    Usage

    Arguments

    path
    -

    path to the xlsForm

    +

    path to the file with the full referential

    @@ -112,7 +109,7 @@

    Returns

    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)
@@ -158,55 +155,63 @@ 
    Examples
    
 ## ------------------------------------------------
 
 ref <- Referential$new(
-  path = system.file("household_survey_americas.xlsx", package = "surveyDesigner") 
+  path = system.file("SurveyDesigner_Referential.xlsx", package = "surveyDesigner") 
 )
+#> New names:
+#> • `` -> `...14`
 #> result is store in `by_groups` sub-element
 
 head(ref$data$survey)
-#> # A tibble: 6 × 19
-#>   type    name  `label::English (en)` `label::Spanish (es)` `label::French (fr)`
-#>   <chr>   <chr> <chr>                 <chr>                 <chr>               
-#> 1 start   start NA                    NA                    NA                  
-#> 2 end     end   NA                    NA                    NA                  
-#> 3 calcul… star… NA                    NA                    NA                  
-#> 4 calcul… end_t NA                    NA                    NA                  
-#> 5 calcul… time… Time difference in s… NA                    NA                  
-#> 6 calcul… time… Time difference in m… NA                    NA                  
-#> # ℹ 14 more variables: `label::Arabic (ar)` <chr>, `hint::English (en)` <chr>,
-#> #   `hint::Spanish (es)` <chr>, `hint::French (fr)` <chr>,
-#> #   `hint::Arabic (ar)` <chr>, required <chr>, appearance <chr>,
-#> #   choice_filter <chr>, calculation <chr>, relevant <chr>, constraint <chr>,
-#> #   constraint_message <chr>, repeat_count <chr>, `$given_name` <chr>
+#> # A tibble: 6 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey start  start NA    NA    NA       NA               NA        
+#> 2 household_survey end    end   NA    NA    NA       NA               NA        
+#> 3 household_survey calcu… star… NA    NA    NA       NA               NA        
+#> 4 household_survey calcu… end_t NA    NA    NA       NA               NA        
+#> 5 household_survey calcu… time… Time… NA    NA       NA               NA        
+#> 6 household_survey calcu… time… Time… NA    NA       NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
 
 # Example by groups
 ref$by_groups$group_intro
 #> $data
-#> # A tibble: 6 × 19
-#>   type    name  `label::English (en)` `label::Spanish (es)` `label::French (fr)`
-#>   <chr>   <chr> <chr>                 <chr>                 <chr>               
-#> 1 date    inte… Please enter the dat… Por favor, introduzc… Sélectionnez la dat…
-#> 2 select… Bure… Please select the Re… Seleccione la Oficin… Sélectionnez le bur…
-#> 3 select… Coun… Please select the co… Seleccione el país e… Sélectionnez le pay…
-#> 4 calcul… coun… NA                    NA                    NA                  
-#> 5 geopoi… geop… Record your current … Registre su ubicació… Enregistrez votre p…
-#> 6 select… pop_… Please select which … Seleccione el grupo … Sélectionnez le gro…
-#> # ℹ 14 more variables: `label::Arabic (ar)` <chr>, `hint::English (en)` <chr>,
-#> #   `hint::Spanish (es)` <chr>, `hint::French (fr)` <chr>,
-#> #   `hint::Arabic (ar)` <chr>, required <chr>, appearance <chr>,
-#> #   choice_filter <chr>, calculation <chr>, relevant <chr>, constraint <chr>,
-#> #   constraint_message <chr>, repeat_count <chr>, `$given_name` <chr>
+#> # A tibble: 6 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey date   inte… Plea… NA    false    NA               NA        
+#> 2 household_survey selec… Bure… Plea… Read… true     NA               NA        
+#> 3 household_survey selec… Coun… Plea… Read… true     NA               NA        
+#> 4 household_survey calcu… coun… NA    NA    false    NA               NA        
+#> 5 household_survey geopo… geop… Reco… NA    false    NA               NA        
+#> 6 household_survey selec… pop_… Plea… Read… true     NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
 #> 
 #> $information
-#> # A tibble: 2 × 19
-#>   type    name  `label::English (en)` `label::Spanish (es)` `label::French (fr)`
-#>   <chr>   <chr> <chr>                 <chr>                 <chr>               
-#> 1 begin_… grou… Interview visits      Visitas del entrevis… Visites d'enquête   
-#> 2 end_gr… NA    NA                    NA                    NA                  
-#> # ℹ 14 more variables: `label::Arabic (ar)` <chr>, `hint::English (en)` <chr>,
-#> #   `hint::Spanish (es)` <chr>, `hint::French (fr)` <chr>,
-#> #   `hint::Arabic (ar)` <chr>, required <chr>, appearance <chr>,
-#> #   choice_filter <chr>, calculation <chr>, relevant <chr>, constraint <chr>,
-#> #   constraint_message <chr>, repeat_count <chr>, `$given_name` <chr>
+#> # A tibble: 2 × 33
+#>   referential_id   type   name  label hint  required required_message constraint
+#>   <chr>            <chr>  <chr> <chr> <chr> <chr>    <lgl>            <chr>     
+#> 1 household_survey begin… grou… Inte… NA    false    NA               NA        
+#> 2 household_survey end_g… NA    NA    NA    NA       NA               NA        
+#> # ℹ 25 more variables: constraint_message <chr>, relevant <chr>,
+#> #   appearance <chr>, calculation <chr>, trigger <lgl>, parameters <lgl>,
+#> #   repeat_count <chr>, default <lgl>, read_only <lgl>, choice_filter <chr>,
+#> #   `media::image` <lgl>, `$given_name` <chr>, contextualize <lgl>,
+#> #   contextualize_instruction <lgl>, block <lgl>, block_sequence <lgl>,
+#> #   sequence <lgl>, mode <chr>, check <lgl>, accuracy <lgl>, chapter <lgl>,
+#> #   subchapter <lgl>, labelReport <lgl>, hintReport <lgl>, keyword <lgl>
 #>
    diff --git a/docs/reference/get_choices_for_question.html b/docs/reference/get_choices_for_question.html index 3efd6d4..607e4c4 100644 --- a/docs/reference/get_choices_for_question.html +++ b/docs/reference/get_choices_for_question.html @@ -35,10 +35,7 @@

  • @@ -63,21 +60,17 @@

    Get choices for one question

    • - 
    get_choices_for_question(data, indicator, lg)
    + 
    get_choices_for_question(survey, full_name)

    Arguments

    -
    data
    -

    data of choices

    - - -
    indicator
    -

    the name of the indicator for the question

    +
    survey
    +

    data from the choices sheet

    -
    lg
    -

    language to use

    +
    full_name
    +

    the full name (i.e. concatenating groups) for the variable

    diff --git a/docs/reference/get_groups.html b/docs/reference/get_groups.html index eeb6142..a42926f 100644 --- a/docs/reference/get_groups.html +++ b/docs/reference/get_groups.html @@ -35,10 +35,7 @@
  • @@ -69,7 +66,7 @@

    Get groups form begin and end into a list with data and information

    Arguments

    data
    -

    data form the survey sheet

    +

    data from the survey sheet

    diff --git a/docs/reference/index.html b/docs/reference/index.html index f9b620b..d43dd51 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -35,10 +35,7 @@
  • diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html index ba3c5a2..2a1dcdd 100644 --- a/docs/reference/pipe.html +++ b/docs/reference/pipe.html @@ -35,10 +35,7 @@
  • diff --git a/docs/reference/run_app.html b/docs/reference/run_app.html index d76fa77..74ef308 100644 --- a/docs/reference/run_app.html +++ b/docs/reference/run_app.html @@ -35,10 +35,7 @@
  • diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 1fd5b2d..428c08f 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -15,6 +15,9 @@ /articles/class-r6-for-the-referencial.html + + /articles/class-r6-for-the-referential.html + /articles/index.html