https://github.com/openwashdata/breathablepitlat
https://github.com/openwashdata/breathablepitlat
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openwashdata/breathablepitlat
- Owner: openwashdata
- License: cc-by-4.0
- Created: 2024-06-21T09:13:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T08:13:49.000Z (over 1 year ago)
- Last Synced: 2025-09-04T23:16:10.402Z (9 months ago)
- Language: R
- Homepage: https://openwashdata.github.io/breathablepitlat/
- Size: 2.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
---
output: github_document
always_allow_html: true
editor_options:
markdown:
wrap: 72
chunk_output_type: console
---
```{r, include = FALSE}
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'
)
devtools::load_all()
```
# breathablepitlat
[](https://creativecommons.org/licenses/by/4.0/)
[](https://zenodo.org/doi/10.5281/zenodo.13960699)
The goal of breathablepitlat is to demonstrate the transport of
contaminants from two pour flush, twin-pit latrines in which one pit is
lined and one is unlined.
## Installation
You can install the development version of breathablepitlat from
[GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("openwashdata/breathablepitlat")
```
```{r}
## 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.
```{r, echo=FALSE, message=FALSE, warning=FALSE}
extdata_path <- "https://github.com/openwashdata/breathablepitlat/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 one dataset `breathablepitlat`.
```{r}
library(breathablepitlat)
```
### breathablepitlat
The dataset `breathablepitlat` contains data about ... It has
`r nrow(breathablepitlat)` observations and `r ncol(breathablepitlat)`
variables
```{r}
breathablepitlat |>
head(3) |>
gt::gt() |>
gt::as_raw_html()
```
For an overview of the variable names, see the following table.
```{r echo=FALSE, message=FALSE, warning=FALSE}
readr::read_csv("data-raw/dictionary.csv") |>
dplyr::filter(file_name == "breathablepitlat.rda") |>
dplyr::select(variable_name:description) |>
knitr::kable() |>
kableExtra::kable_styling("striped") |>
kableExtra::scroll_box(height = "200px")
```
## Example
Geographical location of the study site. The village locates in the
delta area adjacent to the Ganga River along the border of Fatehpur
District, Uttar Pradesh province, India.
```{r}
library(breathablepitlat)
library(tidyverse)
mean_location <- breathablepitlat |>
filter(!str_detect(location, "ined")) |>
filter(num_test=TRUE) |>
group_by(test, site, location) |>
summarize(mean = mean(values, na.rm = TRUE),
std_error = sd(values, na.rm = TRUE) / sqrt(n()),
count=n()
)
# Provide some example code here
ggplot(data = mean_location,
mapping = aes(x = site,
y = mean,
fill = location)) +
geom_col(position = position_dodge2()) +
facet_wrap(~test, scales = "free")+
theme_minimal() +
labs(title = "Contamination around pit latrines",
subtitle = "Mean of six soil quality tests displayed by site",
x = "Site #",
y = "Mean values",
fill = "Sample location around the pit",
caption = "Data collected from Dec 2021-Dec 2022")+
theme(panel.grid.minor = element_blank(),
panel.grid.major.y = element_blank())
```
## License
Data are available as
[CC-BY](https://github.com/openwashdata/breathablepitlat/blob/main/LICENSE.md).
## Citation
Please cite this package using:
```{r}
citation("breathablepitlat")
```