From d0dda5723090fa9cdeef380c1e604ffd69732d71 Mon Sep 17 00:00:00 2001 From: Ernest Guevarra Date: Mon, 19 Jan 2026 23:31:28 +0000 Subject: [PATCH 1/3] general maintenance and upkeep changes and updates --- .Rbuildignore | 1 + .github/CONTRIBUTING.md | 2 +- .github/workflows/R-CMD-check.yaml | 5 +- .github/workflows/mirror-codeberg.yaml | 19 ++++ .github/workflows/netlify.yaml | 53 ++++++++++ .github/workflows/pkgdown.yaml | 5 +- .github/workflows/test-coverage.yaml | 20 +++- CITATION.cff | 141 +++++++++++++++++++++++++ DESCRIPTION | 4 +- NEWS.md | 3 +- README.Rmd | 21 +++- README.md | 37 +++++-- cran-comments.md | 49 +++++++-- inst/CITATION | 4 +- inst/WORDLIST | 8 +- pkgdown/_pkgdown.yml | 28 +++-- revdep/.gitignore | 1 + revdep/README.md | 32 +++--- vignettes/washdata.Rmd | 18 ++-- 19 files changed, 384 insertions(+), 67 deletions(-) create mode 100644 .github/workflows/mirror-codeberg.yaml create mode 100644 .github/workflows/netlify.yaml create mode 100644 CITATION.cff diff --git a/.Rbuildignore b/.Rbuildignore index 63c3148..59ff8bc 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,3 +16,4 @@ ^_pkgdown\.yml$ ^pkgdown$ ^CRAN-SUBMISSION$ +^CITATION\.cff$ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6245460..2057166 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,7 +8,7 @@ * Fork this repository to your Github account -* Clone your version on your account down to your machine from your account +* Clone your forked version to your machine ``` git clone https://github.com//washdata.git diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 14159b7..562fe0f 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -4,9 +4,10 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] -name: R-CMD-check +name: R-CMD-check.yaml + +permissions: read-all jobs: R-CMD-check: diff --git a/.github/workflows/mirror-codeberg.yaml b/.github/workflows/mirror-codeberg.yaml new file mode 100644 index 0000000..dce7ed4 --- /dev/null +++ b/.github/workflows/mirror-codeberg.yaml @@ -0,0 +1,19 @@ +name: Mirror to other git server +on: + push: + branches: + - main + tags: + - "*" +jobs: + mirror: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: yesolutions/mirror-action@master + with: + REMOTE: https://codeberg.org/katilingban/washdata + GIT_USERNAME: ${{ secrets.CODEBERG_USERNAME }} + GIT_PASSWORD: ${{ secrets.CODEBERG_TOKEN }} diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml new file mode 100644 index 0000000..10c6fe1 --- /dev/null +++ b/.github/workflows/netlify.yaml @@ -0,0 +1,53 @@ +on: + pull_request: + branches: [main, master] + +name: pkgdown-pr + +jobs: + netlify: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-tinytex@v2 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Install package + run: R CMD INSTALL . + + - name: Create website + run: | + pkgdown::build_site() + shell: Rscript {0} + + - name: Create index file + run: | + echo ' ' > ./docs/index.html + + - name: Deploy to Netlify + uses: nwtgck/actions-netlify@v3.0 + with: + publish-dir: './docs' + production-branch: main + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: + 'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})' + # these default to 'true' + enable-commit-comment: false + enable-github-deployment: false + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index a7276e8..bfc9f4d 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -4,12 +4,13 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] release: types: [published] workflow_dispatch: -name: pkgdown +name: pkgdown.yaml + +permissions: read-all jobs: pkgdown: diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index 21b8a93..0ab748d 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -4,9 +4,10 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] -name: test-coverage +name: test-coverage.yaml + +permissions: read-all jobs: test-coverage: @@ -23,18 +24,29 @@ jobs: - uses: r-lib/actions/setup-r-dependencies@v2 with: - extra-packages: any::covr + extra-packages: any::covr, any::xml2 needs: coverage - name: Test coverage run: | - covr::codecov( + cov <- covr::package_coverage( quiet = FALSE, clean = FALSE, install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") ) + print(cov) + covr::to_cobertura(cov) shell: Rscript {0} + - uses: codecov/codecov-action@v5 + with: + # Fail if error if not on PR, or if on PR and token is given + fail_ci_if_error: ${{ github.event_name != 'pull_request' || secrets.CODECOV_TOKEN }} + files: ./cobertura.xml + plugins: noop + disable_search: true + token: ${{ secrets.CODECOV_TOKEN }} + - name: Show testthat output if: always() run: | diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..135b86c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,141 @@ +# -------------------------------------------- +# CITATION file created with {cffr} R package +# See also: https://docs.ropensci.org/cffr/ +# -------------------------------------------- + +cff-version: 1.2.0 +message: 'To cite package "washdata" in publications use:' +type: software +license: CC0-1.0 +title: 'washdata: Urban Water and Sanitation Survey Dataset' +version: 0.1.5 +doi: 10.5281/zenodo.4058890 +identifiers: +- type: doi + value: 10.32614/CRAN.package.washdata +- type: url + value: https://katilingban.io/washdata/ +abstract: Urban water and sanitation survey dataset collected by Water and Sanitation + for the Urban Poor (WSUP) with technical support from Valid International. These + citywide surveys have been collecting data allowing water and sanitation service + levels across the entire city to be characterised, while also allowing more detailed + data to be collected in areas of the city of particular interest. These surveys + are intended to generate useful information for others working in the water and + sanitation sector. Current release version includes datasets collected from a survey + conducted in Dhaka, Bangladesh in March 2017. 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. +authors: +- family-names: Guevarra + given-names: Ernest + email: ernestgmd@gmail.com +preferred-citation: + type: manual + title: 'washdata: Urban Water and Sanitation Survey Dataset' + authors: + - name: Ernest Guevarra + year: '2026' + notes: R package version 0.1.5 + url: https://katilingban.io/washdata/ + doi: 10.5281/zenodo.4058890 +repository: https://CRAN.R-project.org/package=washdata +repository-code: https://github.com/katilingban/washdata +url: https://github.com/katilingban/washdata/ +contact: +- family-names: Guevarra + given-names: Ernest + email: ernestgmd@gmail.com +keywords: +- dataset +- sanitation +- urban +- wash +- water +references: +- type: software + title: 'R: A Language and Environment for Statistical Computing' + notes: Depends + url: https://www.R-project.org/ + authors: + - name: R Core Team + institution: + name: R Foundation for Statistical Computing + address: Vienna, Austria + year: '2026' + version: '>= 2.10' +- type: software + title: knitr + abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' + notes: Suggests + url: https://yihui.org/knitr/ + repository: https://CRAN.R-project.org/package=knitr + authors: + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + year: '2026' + doi: 10.32614/CRAN.package.knitr +- type: software + title: rmarkdown + abstract: 'rmarkdown: Dynamic Documents for R' + notes: Suggests + url: https://pkgs.rstudio.com/rmarkdown/ + repository: https://CRAN.R-project.org/package=rmarkdown + authors: + - family-names: Allaire + given-names: JJ + email: jj@posit.co + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + - family-names: Dervieux + given-names: Christophe + email: cderv@posit.co + orcid: https://orcid.org/0000-0003-4474-2498 + - family-names: McPherson + given-names: Jonathan + email: jonathan@posit.co + - family-names: Luraschi + given-names: Javier + - family-names: Ushey + given-names: Kevin + email: kevin@posit.co + - family-names: Atkins + given-names: Aron + email: aron@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Cheng + given-names: Joe + email: joe@posit.co + - family-names: Chang + given-names: Winston + email: winston@posit.co + - family-names: Iannone + given-names: Richard + email: rich@posit.co + orcid: https://orcid.org/0000-0003-3925-190X + year: '2026' + doi: 10.32614/CRAN.package.rmarkdown +- type: software + title: spelling + abstract: 'spelling: Tools for Spell Checking in R' + notes: Suggests + url: https://ropensci.r-universe.dev/spelling + repository: https://CRAN.R-project.org/package=spelling + authors: + - family-names: Ooms + given-names: Jeroen + email: jeroenooms@gmail.com + orcid: https://orcid.org/0000-0002-4035-0289 + - family-names: Hester + given-names: Jim + email: james.hester@rstudio.com + year: '2026' + doi: 10.32614/CRAN.package.spelling + diff --git a/DESCRIPTION b/DESCRIPTION index 03b87b1..b7de4da 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: washdata Title: Urban Water and Sanitation Survey Dataset -Version: 0.1.4.9000 +Version: 0.1.5 Authors@R: c( person("Ernest", "Guevarra", email = "ernestgmd@gmail.com", role = c("aut", "cre")), person("Valid International", "", email = "office@validinternational.org", role = "cph"), @@ -29,7 +29,7 @@ License: CC0 Encoding: UTF-8 Language: en-GB LazyData: true -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.3 URL: https://github.com/katilingban/washdata/, https://katilingban.io/washdata/ BugReports: https://github.com/katilingban/washdata/issues VignetteBuilder: knitr diff --git a/NEWS.md b/NEWS.md index 77c6719..8e39a7d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,5 @@ -# washdata (development version) +# washdata 0.1.5 +* general maintenance and upkeep changes and updates # washdata 0.1.4 * general documentation and formatting updates diff --git a/README.Rmd b/README.Rmd index 81343bc..a68540c 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,13 +16,19 @@ knitr::opts_chunk$set( # washdata: Urban Water and Sanitation Survey Dataset +[![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: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![CRAN status](https://www.r-pkg.org/badges/version/washdata)](https://CRAN.R-project.org/package=washdata) +[![cran checks](https://badges.cranchecks.info/worst/washdata.svg)](https://cran.r-project.org/web/checks/check_results_washdata.html) [![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md) [![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata) [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata) [![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml) +[![test-coverage](https://github.com/katilingban/washdata/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/test-coverage.yaml) +[![Codecov test coverage](https://codecov.io/gh/katilingban/washdata/graph/badge.svg)](https://app.codecov.io/gh/katilingban/washdata) [![CodeFactor](https://www.codefactor.io/repository/github/katilingban/washdata/badge)](https://www.codefactor.io/repository/github/katilingban/washdata) [![DOI](https://zenodo.org/badge/115544360.svg)](https://zenodo.org/doi/10.5281/zenodo.4058889) +[![DOI](https://img.shields.io/badge/DOI-10.32614/CRAN.package.washdata-blue)](https://doi.org/10.32614/CRAN.package.washdata) 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. @@ -45,13 +51,24 @@ To install the package, issue the following commands in R: install.packages("washdata") ``` +::: {.package-devel} Install development version of the package via GitHub: ```R -# if (!require) remotes install.packages("remotes") -remotes::install_github("katilingban/washdata") +# if (!require(pak)) install.packages("pak") +pak::pak("katilingban/washdata") ``` +You can also install the package through the [Katilingban R Universe](https://katilingban.r-universe.dev) with: + +```R +install.packages( + "washdata", + repos = c('https://katilingban.r-universe.dev', 'https://cloud.r-project.org') +) +``` +::: + ## Citation If you find the `washdata` package useful please cite using the suggested citation provided by a call to the `citation()` function as follows: diff --git a/README.md b/README.md index 568da4d..9549b78 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,25 @@ +[![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: +stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![CRAN status](https://www.r-pkg.org/badges/version/washdata)](https://CRAN.R-project.org/package=washdata) +[![cran +checks](https://badges.cranchecks.info/worst/washdata.svg)](https://cran.r-project.org/web/checks/check_results_washdata.html) [![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md) [![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata) [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata) [![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml) +[![test-coverage](https://github.com/katilingban/washdata/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/test-coverage.yaml) +[![Codecov test +coverage](https://codecov.io/gh/katilingban/washdata/graph/badge.svg)](https://app.codecov.io/gh/katilingban/washdata) [![CodeFactor](https://www.codefactor.io/repository/github/katilingban/washdata/badge)](https://www.codefactor.io/repository/github/katilingban/washdata) [![DOI](https://zenodo.org/badge/115544360.svg)](https://zenodo.org/doi/10.5281/zenodo.4058889) +[![DOI](https://img.shields.io/badge/DOI-10.32614/CRAN.package.washdata-blue)](https://doi.org/10.32614/CRAN.package.washdata) This package contains four datasets from an urban water and sanitation @@ -54,13 +65,27 @@ To install the package, issue the following commands in R: install.packages("washdata") ``` +
+ Install development version of the package via GitHub: ``` r -# if (!require) remotes install.packages("remotes") -remotes::install_github("katilingban/washdata") +# if (!require(pak)) install.packages("pak") +pak::pak("katilingban/washdata") +``` + +You can also install the package through the [Katilingban R +Universe](https://katilingban.r-universe.dev) with: + +``` r +install.packages( + "washdata", + repos = c('https://katilingban.r-universe.dev', 'https://cloud.r-project.org') +) ``` +
+ ## Citation If you find the `washdata` package useful please cite using the @@ -71,9 +96,9 @@ follows: citation("washdata") #> To cite washdata in publications use: #> -#> Ernest Guevarra (2024). _washdata: Urban Water and Sanitation Survey +#> Ernest Guevarra (2026). _washdata: Urban Water and Sanitation Survey #> Dataset_. doi:10.5281/zenodo.4058890 -#> , R package version 0.1.4, +#> , R package version 0.1.5, #> . #> #> A BibTeX entry for LaTeX users is @@ -81,8 +106,8 @@ citation("washdata") #> @Manual{, #> title = {washdata: Urban Water and Sanitation Survey Dataset}, #> author = {{Ernest Guevarra}}, -#> year = {2024}, -#> note = {R package version 0.1.4}, +#> year = {2026}, +#> note = {R package version 0.1.5}, #> url = {https://katilingban.io/washdata/}, #> doi = {10.5281/zenodo.4058890}, #> } diff --git a/cran-comments.md b/cran-comments.md index d038f58..6c8d736 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,18 +1,49 @@ ## Release summary -This is the third release of `washdata`. It provides general documentation and -formatting updates. +This is the fourth release of `washdata`. It provides general maintenance and upkeep changes and updates. ## Test environments -* local ubuntu 22.04 install, R 4.3.3 -* macos-latest (on GitHub Actions), release -* windows-latest (on GitHub Actions), release -* ubuntu-latest (on GitHub Actions), release, devel, and oldrelease -* mac-builder (release) -* win-builder (devel, release, oldrelease) -* rhub (windows-devel, fedora-devel, linux-devel, macos-devel) +* local OS X install, R 4.5.2 +* local ubuntu 22.04 install, R 4.5.2 +* win-builder (devel, release, and old release) +* github actions windows-latest, r: release +* github actions macOS-latest, r: release +* github actions ubuntu-24.04, r: release, devel, old release +* rhub windows-latest r devel +* rhub ubuntu 24.04 r devel +* rhub macos r devel +* rhub macos-arm64 r devel +* macbuilder (devel) ## R CMD check results +### Local checks + +0 errors | 0 warnings | 0 notes + +### win-builder checks - devel and release + +0 errors | 0 warnings | 0 notes + +### win-builder checks - old release + +0 errors | 0 warnings | 1 note + +Author field differs from that derived from Authors@R + Author: 'Ernest Guevarra [aut, cre] (ORCID: )' + Authors@R: 'Ernest Guevarra [aut, cre] ()' + +Both ORCID information are the same but formatted differently. + +### GitHub Actions checks + +0 errors | 0 warnings | 0 notes + +### rhub checks + +0 errors | 0 warnings | 0 notes + +### macbuilder checks + 0 errors | 0 warnings | 0 notes ## Reverse dependencies diff --git a/inst/CITATION b/inst/CITATION index c1292df..479e98d 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -3,8 +3,8 @@ bibentry( header = "To cite washdata in publications use:", title = "washdata: Urban Water and Sanitation Survey Dataset", author = person("Ernest Guevarra"), - year = "2024", - note = "R package version 0.1.4", + year = "2026", + note = "R package version 0.1.5", url = "https://katilingban.io/washdata/", doi = "10.5281/zenodo.4058890" ) diff --git a/inst/WORDLIST b/inst/WORDLIST index 6229304..f03123d 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -2,16 +2,22 @@ CMAM CMD CSAS CTC +CodeFactor +Codecov DEFF DHS Drs FANTA +FHI Hijmans IFI +International’s JMP KML +Katilingban LQAS Lanata +Lifecycle Nakuru OCHA OSM @@ -30,6 +36,7 @@ Valadez WSUP WSUP's WorldPop +cran dynamising etc frac @@ -41,4 +48,3 @@ quadrat se sharecrop slums’ -’s diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index 44fe9dc..9597398 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -8,8 +8,18 @@ development: template: bootstrap: 5 bootswatch: sandstone - theme: haddock - ganalytics: # + theme: breeze-light + includes: + in_header: | + + + home: links: @@ -18,19 +28,19 @@ home: navbar: bg: primary - type: light + type: dark structure: left: [home, intro, reference, articles, news] - right: [mastodon, linkedin, github] + right: [search, mastodon, bluesky, linkedin, github] components: - # articles: - # text: Articles - # menu: - # - text: "Africa CDC" - # href: articles/africa-cdc.html mastodon: icon: "fab fa-mastodon fa-lg" + aria-label: Mastodon href: https://fosstodon.org/@katilingban + bluesky: + icon: "fab fa-bluesky fa-lg" + aria-label: Bluesky + href: https://bsky.app/profile/katilingban.io linkedin: icon: "fab fa-linkedin fa-lg" href: https://www.linkedin.com/company/katilingban diff --git a/revdep/.gitignore b/revdep/.gitignore index 31f6c40..bc768ae 100644 --- a/revdep/.gitignore +++ b/revdep/.gitignore @@ -4,3 +4,4 @@ checks.noindex library.noindex data.sqlite *.html +cloud.noindex diff --git a/revdep/README.md b/revdep/README.md index b4d8662..ea363cf 100644 --- a/revdep/README.md +++ b/revdep/README.md @@ -1,24 +1,24 @@ # Platform -|field |value | -|:--------|:----------------------------------------------------------------------------| -|version |R version 4.3.3 (2024-02-29) | -|os |Pop!_OS 22.04 LTS | -|system |x86_64, linux-gnu | -|ui |RStudio | -|language |(EN) | -|collate |en_GB.UTF-8 | -|ctype |en_GB.UTF-8 | -|tz |Europe/London | -|date |2024-04-11 | -|rstudio |2023.12.1+402 Ocean Storm (desktop) | -|pandoc |3.1.1 @ /usr/lib/rstudio/resources/app/bin/quarto/bin/tools/ (via rmarkdown) | +|field |value | +|:--------|:---------------------------------| +|version |R version 4.5.2 (2025-10-31) | +|os |Pop!_OS 22.04 LTS | +|system |x86_64, linux-gnu | +|ui |Positron | +|language |(EN) | +|collate |en_GB.UTF-8 | +|ctype |en_GB.UTF-8 | +|tz |Europe/London | +|date |2026-01-19 | +|pandoc |3.8.3 @ /usr/bin/ (via rmarkdown) | +|quarto |1.8.26 @ /opt/quarto/bin/quarto | # Dependencies -|package |old |new |Δ | -|:--------|:---|:-----|:--| -|washdata |NA |0.1.3 |* | +|package |old |new |Δ | +|:--------|:-----|:-----|:--| +|washdata |0.1.4 |0.1.5 |* | # Revdeps diff --git a/vignettes/washdata.Rmd b/vignettes/washdata.Rmd index 0cab58c..a63b94b 100644 --- a/vignettes/washdata.Rmd +++ b/vignettes/washdata.Rmd @@ -26,19 +26,19 @@ Without functional WASH sectors that can deliver new service delivery models at ## Water and Sanitation for the Urban Poor (WSUP) WSUP is a not-for-profit company that helps transform cities to benefit the millions who lack access to water and sanitation. WSUP believes that access to safe and affordable water, improved sanitation and improved hygiene practices underpin poverty reduction through impacts on health, education and livelihoods. This is coupled with a conviction in two core principles. Firstly, WSUP believes in the transformative power of markets and innovation: enormous strides can be made by bringing the local and international private sector into the urban WASH space, by driving business thinking in low-income service provision, and by viewing low-income people as consumers who make choices. Secondly, WSUP understands that the dynamising power of markets can only partially solve the problem: deep political commitment, institutional change, and a functioning WASH sector are equally critical. Sustainable at-scale progress in urban WASH will only be achieved if political leaders prioritise government investment and policy change, and if WASH service providers are assisted to radically enhance their capacity to deliver effectively on that investment. -## [Valid International](http://www.validinternational.org) -[Valid International (Valid)](http://www.validinternational.org) is a limited company registered in the UK. The company was founded by Drs Steve Collins and Alistair Hallam in 1999 to improve the quality, impact and accountability of global health and nutrition interventions. [Valid](http://www.validinternational.org) pioneered the Community-based Management of Acute Malnutrition (CMAM) model for addressing Severe Acute Malnutrition (SAM) at scale as well as the local production of Ready to Use Therapeutic Food (RUTF), and was the central force behind the advocacy leading to the endorsement of the model by the UN and multiple national governments in 2007. To date, the approach has been adopted in over 60 countries worldwide. +## Valid International +Valid International (Valid) is a limited company registered in the UK. The company was founded by Drs Steve Collins and Alistair Hallam in 1999 to improve the quality, impact and accountability of global health and nutrition interventions. Valid pioneered the Community-based Management of Acute Malnutrition (CMAM) model for addressing Severe Acute Malnutrition (SAM) at scale as well as the local production of Ready to Use Therapeutic Food (RUTF), and was the central force behind the advocacy leading to the endorsement of the model by the UN and multiple national governments in 2007. To date, the approach has been adopted in over 60 countries worldwide. -Over the past ten years, [Valid International](http://www.validinternational.org) has been the primary provider of technical services for the set-up, training and monitoring and evaluation of CMAM programmes all over the world. As part of this, [Valid International](http://www.validinternational.org) has developed various tools and methods that facilitate the provision of these services. For CMAM setup and training, [Valid](http://www.validinternational.org) has published a field manual for CMAM[^1] that gives detailed guidance for the set up and implementation of CMAM. In addition, [Valid](http://www.validinternational.org) has supported the development of CMAM training modules with support and funding from FANTA[^2]. +Over the past ten years, Valid International has been the primary provider of technical services for the set-up, training and monitoring and evaluation of CMAM programmes all over the world. As part of this, Valid International has developed various tools and methods that facilitate the provision of these services. For CMAM setup and training, Valid has published a field manual for CMAM[^1] that gives detailed guidance for the set up and implementation of CMAM. In addition, Valid has supported the development of CMAM training modules with support and funding from FANTA[^2]. -[Valid International](http://www.validinternational.org)’s assessment arm **Valid Measures** started work 15 years ago to address the urgent need for a survey method that could accurately measure the coverage of selective feeding programmes such as CMAM. We have now developed several innovative approaches for needs assessment and monitoring and evaluation of the coverage and effectiveness of nutrition interventions, including the `Simple Spatial Survey Method (S3M)`, `Rapid Assessment Method (RAM)`, `Semi-quantitative Evaluation of Access and Coverage (SQUEAC)`, and `Simplified Lot Quality Assurance Sampling Evaluation of Access and Coverage (SLEAC)`.[^3] Taken together, these approaches have improved assessment outputs over the standard cluster sample approach used in health and nutrition surveys, including improved precision of results, speed of data collection, understanding of barriers and boosters to service access, spatially even distribution of data collection, and detailed spatial mapping of indicator results. +Valid International’s assessment arm **Valid Measures** started work 15 years ago to address the urgent need for a survey method that could accurately measure the coverage of selective feeding programmes such as CMAM. We have now developed several innovative approaches for needs assessment and monitoring and evaluation of the coverage and effectiveness of nutrition interventions, including the `Simple Spatial Survey Method (S3M)`, `Rapid Assessment Method (RAM)`, `Semi-quantitative Evaluation of Access and Coverage (SQUEAC)`, and `Simplified Lot Quality Assurance Sampling Evaluation of Access and Coverage (SLEAC)`.[^3] Taken together, these approaches have improved assessment outputs over the standard cluster sample approach used in health and nutrition surveys, including improved precision of results, speed of data collection, understanding of barriers and boosters to service access, spatially even distribution of data collection, and detailed spatial mapping of indicator results. Whist this work was initially focussed on the measurement of coverage of feeding interventions it has now expanded to assess multiple indicator sets, making the methodologies suitable for evaluation of a broad range of multi-sectoral interventions and practices including the assessment of WASH indicators. ## Background to the citywide surveys In order to measure sustained universal coverage in urban areas of WSUP programme countries[^4], WSUP will be conducting citywide surveys in one selected city for each of our six programme countries in early 2017 and early 2020. These citywide surveys will collect data allowing service levels across the entire city to be characterised, while also allowing more detailed data to be collected in areas of the city of particular interest to WSUP. These surveys are intended to generate useful information for others working in the sector including the municipality, regulator and local utilities. -In support of these citywide surveys, [Valid International](http://www.validinternational.org) has been contracted to provide technical support with the design of the citywide surveys, with particular focus on the technical design of variable density sampling approaches that enable a general characterisation of the entire city, while allowing higher-resolution data to be obtained in areas of specific WSUP interest. This should be achieved while minimising the sample size as far as possible provided that it retains the ability to generate statistically significant conclusions. +In support of these citywide surveys, Valid International has been contracted to provide technical support with the design of the citywide surveys, with particular focus on the technical design of variable density sampling approaches that enable a general characterisation of the entire city, while allowing higher-resolution data to be obtained in areas of specific WSUP interest. This should be achieved while minimising the sample size as far as possible provided that it retains the ability to generate statistically significant conclusions. ## WSUP information requirements and other survey design considerations @@ -218,10 +218,8 @@ At each cluster, a total of two households will be selected. The cluster will be It is very likely that the spatial organisation of the various cities to be sampled will be different between each other. Also, within each city, there will be differences in the setting and organisation of buildings and houses in different parts of the city which will require adjustments or variations to the general approach for stage 2 sampling described above specifically for selecting the second household. This is something that will require investigation and testing prior to the start of the survey in every city and experiences documented in the process document produced during and after the survey process. This will help in producing more nuanced guidelines on other approaches to stage 2 sampling. -## Endnotes - -[^1]: Valid International, 2006. Community-based Therapeutic Care (CTC): A Field Manual, Oxford: Valid International. Available at -[^2]: see +[^1]: Valid International, 2006. Community-based Therapeutic Care (CTC): A Field Manual, Oxford: Valid International. +[^2]: see Food and Nutrition Technical Assistance III Project (FANTA). 2018. Training Guide for Community-Based Management of Acute Malnutrition (CMAM). Washington, DC: FHI 360/FANTA [^3]: **RAM** is a quick, simple and low-cost survey method to assess and monitor individual datasets for multiple health and nutrition indicators for under-five children, older people and other vulnerable groups in different humanitarian crises and development contexts. Compared to other needs assessment and monitoring methodologies, RAM uses a smaller sample size without compromising relative precision and spatial distribution, and is therefore ideal for capturing reliable data for different vulnerable groups, including socio-cultural sub-populations, in a timely and cost-efficient manner. **S3M** is a development of the Centric Systematic Area Sampling (CSAS) method providing better spatial resolution with lower sampling costs. S3M is appropriate for mapping coverage (or prevalence of indicators) over very wide-areas. **SQUEAC** is a semi-quantitative method that provides in-depth analysis of barriers and boosters to coverage. It is designed as a routine program monitoring tool through the intelligent use of routine monitoring data complemented by other relevant data that are collected on a “little and often” basis. **SLEAC** is a rapid low-resource survey method that classifies coverage at the service delivery unit (SDU) level such as the district. A SLEAC survey identifies the category of coverage (e.g. “low coverage”, “moderate coverage” or “high coverage”) that describes the coverage of the service delivery unit being assessed. The advantage of this approach is that relatively small sample sizes (e.g. \(n ≤ 40\)) are required in order to make an accurate and reliable classification. [^4]: Bangladesh, Ghana, Kenya, Madagascar, Mozambique and Zambia [^5]: Main consideration for selecting population of interest is living in areas within the city where WSUP is currently providing interventions or supporting projects @@ -236,7 +234,7 @@ It is very likely that the spatial organisation of the various cities to be samp [^14]: Some modifications to these steps may need to be done on a country by country basis particularly with regard to how the groupings of the spatial units are organised and sub-divided. Otherwise, the general approach is the same on any setting. [^15]: There are many formats for map files. In general, the most common and most accessible formats are keyhole markup language (KML) files which are the standard output format produced by Google Maps/Google Earth and ESRI Shapefiles. [^16]: These days,there are various available online repositories of map data files for most countries including cities. We most commonly use the repository maintained by Robert Hijmans at https://gadm.org and the one maintained by UN OCHA called Humanitarian Data Exchange (https://data.humdata.org). Organisations such as the World Food Programme also maintain their own repositories but most of their maps are also made available through the Humanitarian Data Exchange. -[^17]: The best openly available sources for this map data are from the WorldPop project () and the Global Rural-Urban Mapping Project or GRUMP (). +[^17]: The best openly available sources for this map data are from the [WorldPop project](https://www.worldpop.org) and the [Global Rural-Urban Mapping Project or GRUMP](https://www.earthdata.nasa.gov/data/catalog/sedac-ciesin-sedac-grumpv1-ext-1.00). [^18]: For most cities,this can be available from OpenStreetMap or OSM (). Google Earth can also be used to view satellite imagery of the city. From c8b5b080d2b4ca0ac0175ddd691523fcf12553d8 Mon Sep 17 00:00:00 2001 From: Ernest Guevarra Date: Mon, 19 Jan 2026 23:31:28 +0000 Subject: [PATCH 2/3] general maintenance and upkeep changes and updates --- cran-comments.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/cran-comments.md b/cran-comments.md index 6c8d736..87fd49a 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -20,20 +20,10 @@ This is the fourth release of `washdata`. It provides general maintenance and up 0 errors | 0 warnings | 0 notes -### win-builder checks - devel and release +### win-builder checks 0 errors | 0 warnings | 0 notes -### win-builder checks - old release - -0 errors | 0 warnings | 1 note - -Author field differs from that derived from Authors@R - Author: 'Ernest Guevarra [aut, cre] (ORCID: )' - Authors@R: 'Ernest Guevarra [aut, cre] ()' - -Both ORCID information are the same but formatted differently. - ### GitHub Actions checks 0 errors | 0 warnings | 0 notes From 54d5261612896c71e3c982b7f309b1c36c63c8d4 Mon Sep 17 00:00:00 2001 From: Ernest Guevarra Date: Mon, 19 Jan 2026 23:53:36 +0000 Subject: [PATCH 3/3] from master to main --- README.Rmd | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.Rmd b/README.Rmd index a68540c..389fbfc 100644 --- a/README.Rmd +++ b/README.Rmd @@ -20,7 +20,7 @@ knitr::opts_chunk$set( [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![CRAN status](https://www.r-pkg.org/badges/version/washdata)](https://CRAN.R-project.org/package=washdata) [![cran checks](https://badges.cranchecks.info/worst/washdata.svg)](https://cran.r-project.org/web/checks/check_results_washdata.html) -[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md) +[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/main/LICENSE.md) [![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata) [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata) [![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml) diff --git a/README.md b/README.md index 9549b78..624b69e 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https:// status](https://www.r-pkg.org/badges/version/washdata)](https://CRAN.R-project.org/package=washdata) [![cran checks](https://badges.cranchecks.info/worst/washdata.svg)](https://cran.r-project.org/web/checks/check_results_washdata.html) -[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md) +[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/main/LICENSE.md) [![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata) [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata) [![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml)