Skip to content

Commit

Permalink
rev readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Edouard-Legoupil committed Oct 10, 2023
1 parent 3edd1ed commit 5897ddc
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 21 deletions.
12 changes: 8 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,14 @@ knitr::opts_chunk$set(
<!-- badges: start -->
<!-- badges: end -->

The goal of {rmsSampling} is to ease the implementation of the RMS Sampling guidance
The goal of {rmsSampling} is to ease the implementation of the RMS (Results Monitoring Survey) Sampling guidance, with a perpective of streamlining as many assumptions as possible.

Building a sampling plan is not a mechanical process and needs back and forth review in order to be optimal. Using information already available from UNHCR Official Statistics for each country, and based on the confirmation of sampling assumptions, this companion app will help operations building an initial Methodological Approach Documentation that can then be reviewed by regional DIMA in order to inform the preparation of an RMS survey.

The companion app should help disseminating knowledge on sampling for a non-expert audience (_typically UNHCR Information Management officer in the field_).


This App is still under development - the work in progress version is available here: [https://rstudio.unhcr.org/rmsSampling/](https://rstudio.unhcr.org/rmsSampling/)

## A guided workflow

Expand Down Expand Up @@ -59,9 +65,7 @@ Then for each group a specific tab will be available with a series of conditiona

As an output they can generate a report to document the appropriate sampling approach by country.

## Usage

This App is still under development - the work in progress version is available here: [https://rstudio.unhcr.org/rmsSampling/](https://rstudio.unhcr.org/rmsSampling/)


## Installation

Expand Down
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,23 @@
<!-- badges: end -->

The goal of {rmsSampling} is to ease the implementation of the RMS
Sampling guidance
(Results Monitoring Survey) Sampling guidance, with a perpective of
streamlining as many assumptions as possible.

Building a sampling plan is not a mechanical process and needs back and
forth review in order to be optimal. Using information already available
from UNHCR Official Statistics for each country, and based on the
confirmation of sampling assumptions, this companion app will help
operations building an initial Methodological Approach Documentation
that can then be reviewed by regional DIMA in order to inform the
preparation of an RMS survey.

The companion app should help disseminating knowledge on sampling for a
non-expert audience (*typically UNHCR Information Management officer in
the field*).

This App is still under development - the work in progress version is
available here: <https://rstudio.unhcr.org/rmsSampling/>

## A guided workflow

Expand Down Expand Up @@ -65,11 +81,6 @@ method can apply:
As an output they can generate a report to document the appropriate
sampling approach by country.

## Usage

This App is still under development - the work in progress version is
available here: <https://rstudio.unhcr.org/rmsSampling/>

## Installation

You can install the development version of rmsSampling like so:
Expand Down
10 changes: 4 additions & 6 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ pandoc: 3.1.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
last_built: 2023-09-12T13:57Z
last_built: 2023-10-10T14:28Z

2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 UNHCR Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Edouard Legoupil. Author, maintainer. UNHCR. Copyright holder.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Legoupil E (2023). rmsSampling: UNHCR Dashboard. R package version 0.0.900, https://github.com/unhcr-americas/rmsSampling.","code":"@Manual{, title = {rmsSampling: UNHCR Dashboard}, author = {Edouard Legoupil}, year = {2023}, note = {R package version 0.0.900}, url = {https://github.com/unhcr-americas/rmsSampling}, }"},{"path":"/index.html","id":"rmssampling","dir":"","previous_headings":"","what":"UNHCR Dashboard","title":"UNHCR Dashboard","text":"goal {rmsSampling} ease implementation RMS Sampling guidance","code":""},{"path":"/index.html","id":"a-guided-workflow","dir":"","previous_headings":"","what":"A guided workflow","title":"UNHCR Dashboard","text":"User guided workflow: Select country last population statistics aggregated group pulled RAS - aka REF+ASY+OIP, Refugees, Asylum-seeker Need International Protection - “Pillar-1-Refugee” STA: Stateless Persons – “Pillar-2-Stateless” IDP: Internally displaced Persons - “Pillar-4-IDP” REP (RET+ROC): Returned Refugees & IDPs - “Pillar-3-Reintegration” OOC: Concerns group specific tab available series conditional questions confirm wether one 7 potential sampling method can apply: Flag population groups less 5,000 individuals, confirm really budget implement sampling strategy Request user indicate reliable registration group list available population group Check size country confirm implementation area small (allowing Simple Random Sampling without stratification) Check disaggregation geographic location available within countries (allowing Simple Random Sampling within strata) Check breakdown country Origin confirm potential stratification country orgin make sense Refugee Asylum Seekers? (allowing multiple Stage Cluster Sampling) Check budget time available conduct list exercise (allowing either Probability Proportion Size Adaptive Cluster Sampling) Check population tend gather certain location specific day time? (allowing Location Time Sampling) Check community well connected adequate time conduct formative survey identify sees prepare coupons? (allowing Respondent Driven Sampling) ask expected margin errors, level confidence sample power. output can generate report document appropriate sampling approach country.","code":""},{"path":"/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"UNHCR Dashboard","text":"App still development - work progress version available : https://rstudio.unhcr.org/rmsSampling/","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"UNHCR Dashboard","text":"can install development version rmsSampling like :","code":"install.packages(\"pak\") pak::pkg_install(\"unhcr-americas/rmsSampling\")"},{"path":"/reference/run_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Run the Shiny Application — run_app","title":"Run the Shiny Application — run_app","text":"Run Shiny Application","code":""},{"path":"/reference/run_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run the Shiny Application — run_app","text":"","code":"run_app( onStart = NULL, options = list(), enableBookmarking = NULL, uiPattern = \"/\", ... )"},{"path":"/reference/run_app.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run the Shiny Application — run_app","text":"onStart function called app actually run. needed shinyAppObj, since shinyAppDir case, global.R file can used purpose. options Named options passed runApp call (can following: \"port\", \"launch.browser\", \"host\", \"quiet\", \"display.mode\" \"test.mode\"). can also specify width height parameters provide hint embedding environment ideal height/width app. enableBookmarking Can one \"url\", \"server\", \"disable\". default value, NULL, respect setting previous calls enableBookmarking(). See enableBookmarking() information bookmarking app. uiPattern regular expression applied GET request determine whether ui used handle request. Note entire request path must match regular expression order match considered successful. ... arguments pass golem_opts. See `?golem::get_golem_options` details.","code":""}]
[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 UNHCR Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Edouard Legoupil. Author, maintainer. UNHCR. Copyright holder.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Legoupil E (2023). rmsSampling: UNHCR Dashboard. R package version 0.0.900, https://github.com/unhcr-americas/rmsSampling.","code":"@Manual{, title = {rmsSampling: UNHCR Dashboard}, author = {Edouard Legoupil}, year = {2023}, note = {R package version 0.0.900}, url = {https://github.com/unhcr-americas/rmsSampling}, }"},{"path":"/index.html","id":"rmssampling","dir":"","previous_headings":"","what":"UNHCR Dashboard","title":"UNHCR Dashboard","text":"goal {rmsSampling} ease implementation RMS (Results Monitoring Survey) Sampling guidance, perpective streamlining many assumptions possible. Building sampling plan mechanical process needs back forth review order optimal. Using information already available UNHCR Official Statistics country, based confirmation sampling assumptions, companion app help operations building initial Methodological Approach Documentation can reviewed regional DIMA order inform preparation RMS survey. companion app help disseminating knowledge sampling non-expert audience (typically UNHCR Information Management officer field). App still development - work progress version available : https://rstudio.unhcr.org/rmsSampling/","code":""},{"path":"/index.html","id":"a-guided-workflow","dir":"","previous_headings":"","what":"A guided workflow","title":"UNHCR Dashboard","text":"User guided workflow: Select country last population statistics aggregated group pulled RAS - aka REF+ASY+OIP, Refugees, Asylum-seeker Need International Protection - “Pillar-1-Refugee” STA: Stateless Persons – “Pillar-2-Stateless” IDP: Internally displaced Persons - “Pillar-4-IDP” REP (RET+ROC): Returned Refugees & IDPs - “Pillar-3-Reintegration” OOC: Concerns group specific tab available series conditional questions confirm wether one 7 potential sampling method can apply: Flag population groups less 5,000 individuals, confirm really budget implement sampling strategy Request user indicate reliable registration group list available population group Check size country confirm implementation area small (allowing Simple Random Sampling without stratification) Check disaggregation geographic location available within countries (allowing Simple Random Sampling within strata) Check breakdown country Origin confirm potential stratification country orgin make sense Refugee Asylum Seekers? (allowing multiple Stage Cluster Sampling) Check budget time available conduct list exercise (allowing either Probability Proportion Size Adaptive Cluster Sampling) Check population tend gather certain location specific day time? (allowing Location Time Sampling) Check community well connected adequate time conduct formative survey identify sees prepare coupons? (allowing Respondent Driven Sampling) ask expected margin errors, level confidence sample power. output can generate report document appropriate sampling approach country.","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"UNHCR Dashboard","text":"can install development version rmsSampling like :","code":"install.packages(\"pak\") pak::pkg_install(\"unhcr-americas/rmsSampling\")"},{"path":"/reference/run_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Run the Shiny Application — run_app","title":"Run the Shiny Application — run_app","text":"Run Shiny Application","code":""},{"path":"/reference/run_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run the Shiny Application — run_app","text":"","code":"run_app( onStart = NULL, options = list(), enableBookmarking = NULL, uiPattern = \"/\", ... )"},{"path":"/reference/run_app.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run the Shiny Application — run_app","text":"onStart function called app actually run. needed shinyAppObj, since shinyAppDir case, global.R file can used purpose. options Named options passed runApp call (can following: \"port\", \"launch.browser\", \"host\", \"quiet\", \"display.mode\" \"test.mode\"). can also specify width height parameters provide hint embedding environment ideal height/width app. enableBookmarking Can one \"url\", \"server\", \"disable\". default value, NULL, respect setting previous calls enableBookmarking(). See enableBookmarking() information bookmarking app. uiPattern regular expression applied GET request determine whether ui used handle request. Note entire request path must match regular expression order match considered successful. ... arguments pass golem_opts. See `?golem::get_golem_options` details.","code":""}]
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ title: "UNHCR Results Monitoring Surveys (RMS) for `r countrycode::countrycode(p
---

```{r setup, include=FALSE}
#
knitr::opts_chunk$set(echo = FALSE, fig.cap = TRUE, fig.width = 6.27)
library(officedown)
library(officer)
library(ggplot2)
library(tidyverse)
```


```{r setup2, include=FALSE}
## Get all parameters within a frame for easy rendering
# conf <- data.frame(
# pop = c("RAS","STA","RET","IDP","OOC"),
Expand Down

0 comments on commit 5897ddc

Please sign in to comment.