In washr: Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  message = FALSE,
  warning = FALSE,
  fig.retina = 2,
  fig.align = 'center'
)

{{{packagename}}}

The goal of {{{packagename}}} is to ...

Installation

You can install the development version of {{{packagename}}} from GitHub with:

# install.packages("devtools")
devtools::install_github("openwashdata/{{{packagename}}}")

## Run the following code in console if you don't have the packages
## install.packages(c("dplyr", "knitr", "readr", "stringr", "gt", "kableExtra"))
library(dplyr)
library(knitr)
library(readr)
library(stringr)
library(gt)
library(kableExtra)

Alternatively, you can download the individual datasets as a CSV or XLSX file from the table below.

1. Click Download CSV. A window opens that displays the CSV in your browser.
2. Right-click anywhere inside the window and select "Save Page As...".
3. Save the file in a folder of your choice.

extdata_path <- "https://github.com/openwashdata/{{{packagename}}}/raw/main/inst/extdata/"

read_csv("data-raw/dictionary.csv") |> 
  distinct(file_name) |> 
  dplyr::mutate(file_name = str_remove(file_name, ".rda")) |> 
  dplyr::rename(dataset = file_name) |> 
  mutate(
    CSV = paste0("[Download CSV](", extdata_path, dataset, ".csv)"),
    XLSX = paste0("[Download XLSX](", extdata_path, dataset, ".xlsx)")
  ) |> 
  knitr::kable()

Data

The package provides access to ...

library({{{packagename}}})

{{{dataname}}}

The dataset {{{dataname}}} contains data about ... It has r nrow({{{dataname}}}) observations and r ncol({{{dataname}}}) variables

{{{dataname}}} |> 
  head(3) |> 
  gt::gt() |>
  gt::as_raw_html()

For an overview of the variable names, see the following table.

readr::read_csv("data-raw/dictionary.csv") |>
  dplyr::filter(file_name == "{{{dataname}}}.rda") |>
  dplyr::select(variable_name:description) |> 
  knitr::kable() |> 
  kableExtra::kable_styling("striped") |> 
  kableExtra::scroll_box(height = "200px")

Example

library({{{packagename}}})

# Provide some example code here

License

Data are available as CC-BY.

Citation

Please cite this package using:

citation("{{{packagename}}}")

washr documentation built on April 4, 2025, 1:10 a.m.