Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
^_pkgdown\.yml$
^docs$
^pkgdown$
^CITATION\.cff$
^\.github$
7 changes: 0 additions & 7 deletions .Rhistory

This file was deleted.

1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
53 changes: 53 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# R CMD check on every push and pull request, written by washr::setup_ci().
# Derived from https://github.com/r-lib/actions/tree/v2/examples (check-standard),
# with the dev branch in the triggers as the openwashdata review standard requires.
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master, dev]
pull_request:
branches: [main, master, dev]
workflow_dispatch:

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
build_args: 'c("--no-manual")'
47 changes: 47 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

permissions: read-all

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v6

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
with:
clean: false
branch: gh-pages
folder: docs
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.Rproj.user
docs
.Rhistory
40 changes: 40 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------

cff-version: 1.2.0
message: 'To cite package "handpumpstatusdata" in publications use:'
type: dataset
license: CC-BY-4.0
title: 'handpumpstatusdata: Chiradzulu Handpump Functionality Verification Survey'
version: 1.0.1
doi: 10.5281/zenodo.17474593
abstract: This dataset contains detailed field survey records of borehole and handpump
functionality verification exercises conducted in Chiradzulu District, Malawi in
February 2020.
authors:
- family-names: Mhango
given-names: Emmanuel
email: emmanuellmhango@gmail.com
orcid: https://orcid.org/0000-0003-3197-6244
repository-code: https://github.com/openwashdata/handpumpstatusdata
url: https://github.com/openwashdata/handpumpstatusdata
date-released: '2026-09-23'
contact:
- family-names: Mhango
given-names: Emmanuel
email: emmanuellmhango@gmail.com
orcid: https://orcid.org/0000-0003-3197-6244
keywords:
- open data
- washdata
- handpumps
- boreholes
- water point functionality
- water supply
- Malawi
- handpump
- wash
- waterpoints

7 changes: 5 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: handpumpstatusdata
Title: Chiradzulu Handpump Functionality Verification Survey
Version: 0.0.0.9000
Version: 1.0.1
Authors@R: c(
person("Emmanuel", "Mhango", , "emmanuellmhango@gmail.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-3197-6244")),
Expand All @@ -17,6 +17,9 @@ Depends:
LazyData: true
Language: en-GB
Config/Needs/website: rmarkdown
Date: 2025-08-12
Date: 2026-09-23
URL: https://github.com/openwashdata/handpumpstatusdata
BugReports: https://github.com/openwashdata/handpumpstatusdata/issues
X-schema.org-keywords: open data, washdata, handpumps, boreholes, water point functionality, water supply, Malawi
X-schema.org-spatialCoverage: Chiradzulu, Malawi
X-schema.org-temporalCoverage: 2020-02-06/2020-11-06
7 changes: 7 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# handpumpstatusdata 1.0.1

* Metadata-only release: CITATION.cff and inst/CITATION carry the Zenodo concept DOI and declare the work as a dataset; DESCRIPTION gains keywords; the pkgdown site is configured per the openwashdata standard and deployed from gh-pages; R CMD check runs in CI. The data are unchanged.

# handpumpstatusdata 1.0.0

* First release on Zenodo.
4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ knitr::opts_chunk$set(
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![DOI](https://zenodo.org/badge/1036602560.svg)](https://doi.org/10.5281/zenodo.17474593)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17474593.svg)](https://zenodo.org/doi/10.5281/zenodo.17474593)
[![R-CMD-check](https://github.com/openwashdata/handpumpstatusdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/handpumpstatusdata/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

This dataset contains detailed field survey records of borehole and
Expand Down Expand Up @@ -255,7 +257,7 @@ ggplot(risk_counts, aes(x = risk_factor, y = count, fill = risk_factor)) +
## License

Data are available as
[CC-BY](https://github.com/openwashdata/%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md).
[CC-BY](https://github.com/openwashdata/handpumpstatusdata/blob/main/LICENSE.md).

## Citation

Expand Down
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![DOI](https://zenodo.org/badge/1036602560.svg)](https://doi.org/10.5281/zenodo.17474593)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17474593.svg)](https://zenodo.org/doi/10.5281/zenodo.17474593)
[![R-CMD-check](https://github.com/openwashdata/handpumpstatusdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/handpumpstatusdata/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

This dataset contains detailed field survey records of borehole and
Expand Down Expand Up @@ -119,7 +121,7 @@ handpumpstatusdata |>
gt::as_raw_html()
```

<div id="uowbszxovi" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
<div id="rrexwvzvql" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
&#10; <table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false" style="-webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; font-family: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3;" bgcolor="#FFFFFF">
<thead style="border-style: none;">
<tr class="gt_col_headings" style="border-style: none; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3;">
Expand Down Expand Up @@ -311,8 +313,7 @@ handpumpstatusdata |>
<td headers="parts_for_repair" class="gt_row gt_left" style="border-style: none; padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; text-align: left;" valign="middle" align="left">Bush Bearings, Fulcrum Pin, Centralisers</td>
<td headers="photo_parts" class="gt_row gt_left" style="border-style: none; padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; text-align: left;" valign="middle" align="left">https://api.mwater.co/v3/images/fa4085c66170401cac3b982bfddfd7d2; https://api.mwater.co/v3/images/29afa2c6fbc04b03ab64f69c9f46ca4a; https://api.mwater.co/v3/images/92b8a444a4244f7389d89c1191309a4c; https://api.mwater.co/v3/images/5e7b0546cbca45e38c228f93dfc225bc</td></tr>
</tbody>
&#10;
</table>
&#10;</table>
</div>

For an overview of the variable names, see the following table.
Expand Down Expand Up @@ -1272,7 +1273,7 @@ ggplot(functionality_counts, aes(x = "", y = count, fill = functionality_survey)
)
```

<img src="man/figures/README-unnamed-chunk-7-1.png" width="100%" style="display: block; margin: auto;" />
<img src="man/figures/README-unnamed-chunk-7-1.png" alt="" width="100%" style="display: block; margin: auto;" />

``` r

Expand Down Expand Up @@ -1325,12 +1326,12 @@ ggplot(risk_counts, aes(x = risk_factor, y = count, fill = risk_factor)) +
theme(legend.position = "none")
```

<img src="man/figures/README-unnamed-chunk-7-2.png" width="100%" style="display: block; margin: auto;" />
<img src="man/figures/README-unnamed-chunk-7-2.png" alt="" width="100%" style="display: block; margin: auto;" />

## License

Data are available as
[CC-BY](https://github.com/openwashdata/%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md).
[CC-BY](https://github.com/openwashdata/handpumpstatusdata/blob/main/LICENSE.md).

## Citation

Expand All @@ -1340,17 +1341,21 @@ Please cite this package using:
citation("handpumpstatusdata")
#> To cite package 'handpumpstatusdata' in publications use:
#>
#> Mhango E (2025). _handpumpstatusdata: Chiradzulu Handpump
#> Functionality Verification Survey_. R package version 0.0.0.9000,
#> Mhango E (2026). "handpumpstatusdata: Chiradzulu Handpump
#> Functionality Verification Survey." doi:10.5281/zenodo.17474593
#> <https://doi.org/10.5281/zenodo.17474593>.
#> <https://github.com/openwashdata/handpumpstatusdata>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> @Misc{mhango:2026,
#> title = {handpumpstatusdata: Chiradzulu Handpump Functionality Verification Survey},
#> author = {Emmanuel Mhango},
#> year = {2025},
#> note = {R package version 0.0.0.9000},
#> year = {2026},
#> doi = {10.5281/zenodo.17474593},
#> url = {https://github.com/openwashdata/handpumpstatusdata},
#> abstract = {This dataset contains detailed field survey records of borehole and handpump functionality verification exercises conducted in Chiradzulu District, Malawi in February 2020.},
#> keywords = {open data,washdata,handpumps,boreholes,water point functionality,water supply,Malawi,handpump,wash,waterpoints},
#> version = {0.0.0.9000},
#> }
```
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

url: https://github.com/openwashdata/handpumpstatusdata
url: https://openwashdata.github.io/handpumpstatusdata/
template:
bootstrap: 5
includes:
Expand Down
75 changes: 0 additions & 75 deletions docs/404.html

This file was deleted.

Loading
Loading