-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
67 lines (46 loc) · 3.71 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# washdata: Urban Water and Sanitation Survey Dataset <img src="man/figures/logo.png" width="200" align="right" />
<!-- badges: start -->
[](https://CRAN.R-project.org/package=washdata)
[](https://github.com/katilingban/washdata/blob/master/LICENSE.md)
[](https://cran.r-project.org/package=washdata)
[](https://cran.r-project.org/package=washdata)
[](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml)
[](https://www.codefactor.io/repository/github/katilingban/washdata)
[](https://zenodo.org/doi/10.5281/zenodo.4058889)
<!-- badges: end -->
This package contains four datasets from an urban water and sanitation survey in Dhaka, Bangladesh conducted by [Water and Sanitation for the Urban Poor](https://wsup.com) with technical support from [Valid International](http://www.validinternational.org) in March 2017.
* `popBGD`: Dataset on estimated population of each primary sampling unit (PSU) that were surveyed. This dataset is a mix of data from [WorldPop](https://www.worldpop.org) for the non-slum areas and from the [2014 Bangladesh Census of Slum Areas and Floating Population](https://dataspace.princeton.edu/handle/88435/dsp01wm117r42q).
* `ppiMatrixBGD`: Look-up table for calculating the `Poverty Probability Index` (previously called `Progress out of Poverty Index`) or `PPI` from Bangladesh-specific indicators collected from cross-sectional surveys. This look-up table is extracted from documentation of the `PPI` found at <https://www.povertyindex.org>
* `surveyDataBGD`: Dataset collected through the urban water and sanitation surveys conducted by WSUP in Dhaka, Bangladesh.
* `indicatorsDataBGD`: Dataset produced from `surveyDataBGD` by calculating relevant indicators on water, sanitation and hygiene as specified and defined by WSUP
This survey in Dhaka is one of a series of surveys to be conducted by WSUP in various cities in which they operate including Accra, Ghana; Nakuru, Kenya; Antananarivo, Madagascar; Maputo, Mozambique; and, Lusaka, Zambia. This package will be updated once the surveys in other cities are completed and datasets have been made available.
## Installation
To install the package, issue the following commands in R:
```R
install.packages("washdata")
```
Install development version of the package via GitHub:
```R
# if (!require) remotes install.packages("remotes")
remotes::install_github("katilingban/washdata")
```
## Citation
If you find the `washdata` package useful please cite using the suggested citation provided by a call to the `citation()` function as follows:
```{r citation}
citation("washdata")
```
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/katilingban/washdata/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://katilingban.io/washdata/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://katilingban.io/washdata/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.