README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  message = FALSE,
  warning = FALSE,
  error = FALSE,
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# mozambique: Datasets for Designing Surveys in Mozambique <img src="man/figures/logo.svg" width="200px" align="right"/>

<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/spatialworks/mozambique/workflows/R-CMD-check/badge.svg)](https://github.com/spatialworks/mozambique/actions)
[![test-coverage](https://github.com/spatialworks/mozambique/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/spatialworks/mozambique/actions/workflows/test-coverage.yaml)
[![Codecov test coverage](https://codecov.io/gh/spatialworks/mozambique/branch/master/graph/badge.svg)](https://app.codecov.io/gh/spatialworks/mozambique?branch=master)
[![CodeFactor](https://www.codefactor.io/repository/github/spatialworks/mozambique/badge)](https://www.codefactor.io/repository/github/spatialworks/mozambique)
<!-- badges: end -->

Designing surveys require relevant datasets to be used as basis for sample size calculations, sampling design, survey planning/logistics and survey implementation. These include datasets on population, lists of sampling clusters, map datasets for spatial sampling, and previous survey datasets that can be used for estimating indicator variance and design effects. This package contains relevant datasets for use in designing surveys in Mozambique.

## Installation

You can install the development version from [GitHub](https://github.com/spatialworks/mozambique) with:

## Usage

### Country borders

```{r adm0, echo = TRUE, eval = TRUE, fig.align = "center", fig.width = 10, fig.height = 10, fig.retina = 1}
library(mozambique)

## Retrieve country borders
country <- get_country()

## Plot country borders
plot(sf::st_geometry(country))
```

### Provincias borders

```{r adm1, echo = TRUE, eval = TRUE, fig.align = "center", fig.width = 10, fig.height = 10, fig.retina = 1}
## Retrieve provincias borders
provincias <- get_provinces()

## Plot provincias borders
plot(sf::st_geometry(provincias))
```

### Distritos borders

```{r adm2, echo = TRUE, eval = TRUE, fig.align = "center", fig.width = 10, fig.height = 10, fig.retina = 1}
## Retrieve distritos borders
distritos <- get_districts()

## Plot distritos borders
plot(sf::st_geometry(distritos))
```

### Postos borders

```{r adm3, echo = TRUE, eval = TRUE, fig.align = "center", fig.width = 10, fig.height = 10, fig.retina = 1}
## Retrieve postos borders
postos <- get_posts()

## Plot postos borders
plot(sf::st_geometry(postos))
```

### Settlements

```{r settlements, echo = TRUE, eval = TRUE, fig.align = "center", fig.width = 10, fig.height = 10, fig.retina = 1}
plot(sf::st_geometry(provincias))
plot(sf::st_geometry(settlements), pch = 16, cex = 0.2, col = "blue", add = TRUE)
```