Skip to content

Commit

Permalink
Merge pull request #1 from rapidsurveys/v0.1.1
Browse files Browse the repository at this point in the history
V0.1.1
  • Loading branch information
ernestguevarra authored Jul 4, 2019
2 parents 5c51d91 + a943129 commit 159fde8
Show file tree
Hide file tree
Showing 46 changed files with 2,175 additions and 2,360 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
^\.travis\.yml$
^netlify\.toml$
^appveyor\.yml$
^LICENSE\.md$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.Rhistory
.RData
.Ruserdata
.DS_Store
4 changes: 2 additions & 2 deletions 02-sampling.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ aged 50 years or older” or “persons aged 55 years or older”.

The age distribution of the population and the survey eligibility criteria will affect the sample design in terms of the number of communities that you will need to sample ($m$) and the number of older persons ($n$) that can be sampled from each community.

The overall sample size for a RAM-OP sample should be at least $n = 192$ usually collected as $n = 12$ eligible subjects sampled from $m = 16$ communities. If older people make up a very small proportion (i.e. much less than 5%) of the total population and / or the average population of communities is small then you will usually need to sample more than m = 16 communities in order to get about $n = 192$ older people in the overall sample. This is likely to occur when there are fewer than 20 to 25 older people in a community of average size.
The overall sample size for a RAM-OP sample should be at least $n = 192$ usually collected as $n = 12$ eligible subjects sampled from $m = 16$ communities. If older people make up a very small proportion (i.e. much less than 5%) of the total population and / or the average population of communities is small then you will usually need to sample more than $m = 16$ communities in order to get about $n = 192$ older people in the overall sample. This is likely to occur when there are fewer than 20 to 25 older people in a community of average size.

You can calculate the number of older people that you would expect to be living in a community of average size using the following formula:

Expand Down Expand Up @@ -164,7 +164,7 @@ RANDBETWEEN(1, 4)

 

**Step 3:** Using the *random starting point* and the *sampling interval*, select the sampling villages from a list of all villages organised/sorted by a **non-overalapping** spatial factor such as district or sub-district.
**Step 3:** Using the *random starting point* and the *sampling interval*, select the sampling villages from a list of all villages organised/sorted by a **non-overlapping** spatial factor such as district or sub-district.

\newpage

Expand Down
2 changes: 1 addition & 1 deletion 03-indicators.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ These are standard case definitions for acute malnutrition in adults and recomme

\newpage

```{block2, type = "rmdbox"}
```{block2, type = "rmdnote"}
An estimate of GAM prevalence can be made using a classic estimator:
$$\text{prevalence} = \frac{\text{number of respondents with MUAC < 210 mm}}{\text{total number of respondents}}$$
Expand Down
2 changes: 1 addition & 1 deletion 06-practical.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ Here is a typical timetable of survey activities:
* Review logistics arrangements with the trainees


**At the end of the trainin**
**At the end of the training**

* Provide each trainee with a certificate of attendance
* Pay the training incentives
Expand Down
10 changes: 5 additions & 5 deletions 07-ram_op_software.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ This manual covers analysing your data using the **RAnalyticFlow** workflow. An
To use the **RAnalyticFlow** workflow you must install:

* **The *R Language for Data-Analysis and Graphics* (R)** : This is the *“engine”* which does all the
work of analysing your data. You can get the R installation program from: [http://cran.r-project.org](http://cran.r-project.org). Following are links to download operating sofware-specific versions of R:
work of analysing your data. You can get the R installation program from: [http://cran.r-project.org](http://cran.r-project.org). Following are links to download operating software-specific versions of R:

* [Download R for Linux](https://cran.r-project.org/bin/linux/)

* [Download R for (Mac) OS X](https://cran.r-project.org/bin/macosx/)

* [Download R for Windowx](https://cran.r-project.org/bin/windows/)
* [Download R for Windows](https://cran.r-project.org/bin/windows/)

* **R packages** (libraries of functions needed to work with the **RAnalyticFlow** workflow) : You can install these from within **R** using the Package Installer function within R. The libraries needed are:

Expand Down Expand Up @@ -55,7 +55,7 @@ install.packages(c("rJava", "JavaGD", "codetools",
repos = "https://cloud.r-project.org/")
```

The `repos` argument in the R command above specifies the CRAN mirror from which you to download the package/s you want to install. Here we specify the cloud-based mirror for CRAN provided by RStudio. If unspecified, the installiation process will prompt you to select a mirror from which to download packages from. If you already know the URL of the CRAN mirror you want to use, specify this in the `repos` argument.
The `repos` argument in the R command above specifies the CRAN mirror from which you to download the package/s you want to install. Here we specify the cloud-based mirror for CRAN provided by RStudio. If unspecified, the installation process will prompt you to select a mirror from which to download packages from. If you already know the URL of the CRAN mirror you want to use, specify this in the `repos` argument.

Note that **RAnalyticFlow** may require you to have **Java** installed. Check the instructions on the **RAnalyticFlow** [download page](http://r.analyticflow.com/en/download/) and on this [starter guide](http://download.ef-prime.com/ranalyticflow/3.1.5/readme.html).

Expand Down Expand Up @@ -98,7 +98,7 @@ Before you start work you will need to create a project for your survey:

2. Give your project a useful (i.e. descriptive and memorable) name. This might be a name that describes the survey. For example, if the survey was done in the Kereinik locality of West Darfur in December 2015 you might use the name **WD.Kereinik.Dec2015.RAMOP**

3. Give the location of your project directory or project folder. This is the directory or folder which contains your survey data file, your PSU file, the RAM-OP language file, and a copy of **RAMOP.rflow** (see previous page). The location of the project directory or project folder (labeled “Path” by the software) that **RAnalyticFlow** selects automatically will almost always be wrong. You need to specify this manually.
3. Give the location of your project directory or project folder. This is the directory or folder which contains your survey data file, your PSU file, the RAM-OP language file, and a copy of **RAMOP.rflow** (see previous page). The location of the project directory or project folder (labelled “Path” by the software) that **RAnalyticFlow** selects automatically will almost always be wrong. You need to specify this manually.

4. Click the **OK** button

Expand All @@ -120,7 +120,7 @@ knitr::include_graphics("figures/runWorkflowRAF.png")

Once this is done, you should:

1. Retrieve your survey data. This can be in EpiDat (REC) format or CSV format. Select and run the
1. Retrieve your survey data. This can be in EpiData (REC) format or CSV format. Select and run the
appropriate **Survey Data** node and select the survey data file.

2. Retrieve the PSU date data. Select and run the **PSU Data** node and select your PSU file.
Expand Down
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: ramOPmanual
Title: Rapid Assessment Method for Older People (RAM-OP): The Manual
Version: 0.1.0
Version: 0.1.1
Authors@R: c(
person("Pascale", "Fritsch", role = "aut"),
person("Ernest", "Guevarra", email = "ernest@guevarra.io", role = c("aut", "cre")),
Expand All @@ -14,7 +14,8 @@ Description: HelpAge International <http://www.helpage.org., Valid International
needs of older people. The method uses simple procedures, in a short time
frame (i.e. about two weeks including training, data collection, data entry,
and data analysis), and at considerably lower cost than other methods.
License: GPL-3
Depends: R (>= 3.0.1)
Imports:
bookdown
License: MIT + file LICENSE

Loading

0 comments on commit 159fde8

Please sign in to comment.