Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates for new rhub version #11

Merged
merged 2 commits into from
Apr 12, 2024
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
95 changes: 95 additions & 0 deletions .github/workflows/rhub.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# R-hub's generic GitHub Actions workflow file. It's canonical location is at
# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml
# You can update this file to a newer version using the rhub2 package:
#
# rhub::rhub_setup()
#
# It is unlikely that you need to modify this file manually.

name: R-hub
run-name: "${{ github.event.inputs.id }}: ${{ github.event.inputs.name || format('Manually run by {0}', github.triggering_actor) }}"

on:
workflow_dispatch:
inputs:
config:
description: 'A comma separated list of R-hub platforms to use.'
type: string
default: 'linux,windows,macos'
name:
description: 'Run name. You can leave this empty now.'
type: string
id:
description: 'Unique ID. You can leave this empty now.'
type: string

jobs:

setup:
runs-on: ubuntu-latest
outputs:
containers: ${{ steps.rhub-setup.outputs.containers }}
platforms: ${{ steps.rhub-setup.outputs.platforms }}

steps:
# NO NEED TO CHECKOUT HERE
- uses: r-hub/actions/setup@v1
with:
config: ${{ github.event.inputs.config }}
id: rhub-setup

linux-containers:
needs: setup
if: ${{ needs.setup.outputs.containers != '[]' }}
runs-on: ubuntu-latest
name: ${{ matrix.config.label }}
strategy:
fail-fast: false
matrix:
config: ${{ fromJson(needs.setup.outputs.containers) }}
container:
image: ${{ matrix.config.container }}

steps:
- uses: r-hub/actions/checkout@v1
- uses: r-hub/actions/platform-info@v1
with:
token: ${{ secrets.RHUB_TOKEN }}
job-config: ${{ matrix.config.job-config }}
- uses: r-hub/actions/setup-deps@v1
with:
token: ${{ secrets.RHUB_TOKEN }}
job-config: ${{ matrix.config.job-config }}
- uses: r-hub/actions/run-check@v1
with:
token: ${{ secrets.RHUB_TOKEN }}
job-config: ${{ matrix.config.job-config }}

other-platforms:
needs: setup
if: ${{ needs.setup.outputs.platforms != '[]' }}
runs-on: ${{ matrix.config.os }}
name: ${{ matrix.config.label }}
strategy:
fail-fast: false
matrix:
config: ${{ fromJson(needs.setup.outputs.platforms) }}

steps:
- uses: r-hub/actions/checkout@v1
- uses: r-hub/actions/setup-r@v1
with:
job-config: ${{ matrix.config.job-config }}
token: ${{ secrets.RHUB_TOKEN }}
- uses: r-hub/actions/platform-info@v1
with:
token: ${{ secrets.RHUB_TOKEN }}
job-config: ${{ matrix.config.job-config }}
- uses: r-hub/actions/setup-deps@v1
with:
job-config: ${{ matrix.config.job-config }}
token: ${{ secrets.RHUB_TOKEN }}
- uses: r-hub/actions/run-check@v1
with:
job-config: ${{ matrix.config.job-config }}
token: ${{ secrets.RHUB_TOKEN }}
14 changes: 7 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ knitr::opts_chunk$set(
[![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)
<!-- badges: end -->

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://www.wsup.com) with technical support from [Valid International](http://www.validinternational.org) in March 2017.
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.

* `popBGD`: Dataset on estimated population of each primary sampling unit (PSU) that were surveyed. This dataset is a mix of data from [WorldPop](https://www.worldpop.org) for the non-slum areas and from the [2014 Bangladesh Census of Slum Areas and Floating Population](<http://203.112.218.65:8008/PageWebMenuContent.aspx?MenuKey=423>).
* `popBGD`: Dataset on estimated population of each primary sampling unit (PSU) that were surveyed. This dataset is a mix of data from [WorldPop](https://www.worldpop.org) for the non-slum areas and from the [2014 Bangladesh Census of Slum Areas and Floating Population](https://dataspace.princeton.edu/handle/88435/dsp01wm117r42q).

* `ppiMatrixBGD`: Look-up table for calculating the `Poverty Probability Index` (previously called `Progress out of Poverty Index`) or `PPI` from Bangladesh-specific indicators collected from cross-sectional surveys. This look-up table is extracted from documentation of the `PPI` found at <https://www.povertyindex.org>

* `surveyDataBGD`: Dataset collected through the urban water and sanitation surveys conducted by [WSUP](https://www.wsup.com) in Dhaka, Bangladesh.
* `surveyDataBGD`: Dataset collected through the urban water and sanitation surveys conducted by WSUP in Dhaka, Bangladesh.

* `indicatorsDataBGD`: Dataset produced from `surveyDataBGD` by calculating relevant indicators on water, sanitation and hygiene as specified and defined by [WSUP](https://www.wsup.com)
* `indicatorsDataBGD`: Dataset produced from `surveyDataBGD` by calculating relevant indicators on water, sanitation and hygiene as specified and defined by WSUP

This survey in Dhaka is one of a series of surveys to be conducted by [WSUP](https://www.wsup.com) 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.
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.

## Installation

Expand All @@ -60,6 +60,6 @@ citation("washdata")

## Community guidelines

Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/katilingban/washdata/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/washdata/CONTRIBUTING.html).
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/katilingban/washdata/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://katilingban.io/washdata/CONTRIBUTING.html).

This project is released with a [Contributor Code of Conduct](https://oxford-ihtm.io/washdata/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.
This project is released with a [Contributor Code of Conduct](https://katilingban.io/washdata/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

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://www.wsup.com) with technical support from [Valid
Urban Poor](https://wsup.com) with technical support from [Valid
International](http://www.validinternational.org) in March 2017.

- `popBGD`: Dataset on estimated population of each primary sampling
unit (PSU) that were surveyed. This dataset is a mix of data from
[WorldPop](https://www.worldpop.org) for the non-slum areas and from
the [2014 Bangladesh Census of Slum Areas and Floating
Population](http://203.112.218.65:8008/PageWebMenuContent.aspx?MenuKey=423).
Population](https://dataspace.princeton.edu/handle/88435/dsp01wm117r42q).

- `ppiMatrixBGD`: Look-up table for calculating the
`Poverty Probability Index` (previously called
Expand All @@ -31,19 +31,17 @@ International](http://www.validinternational.org) in March 2017.
<https://www.povertyindex.org>

- `surveyDataBGD`: Dataset collected through the urban water and
sanitation surveys conducted by [WSUP](https://www.wsup.com) in Dhaka,
Bangladesh.
sanitation surveys conducted by WSUP in Dhaka, Bangladesh.

- `indicatorsDataBGD`: Dataset produced from `surveyDataBGD` by
calculating relevant indicators on water, sanitation and hygiene as
specified and defined by [WSUP](https://www.wsup.com)
specified and defined by WSUP

This survey in Dhaka is one of a series of surveys to be conducted by
[WSUP](https://www.wsup.com) 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.
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.

## Installation

Expand Down Expand Up @@ -92,8 +90,8 @@ Feedback, bug reports and feature requests are welcome; file issues or
seek support [here](https://github.com/katilingban/washdata/issues). If
you would like to contribute to the package, please see our
[contributing
guidelines](https://oxford-ihtm.io/washdata/CONTRIBUTING.html).
guidelines](https://katilingban.io/washdata/CONTRIBUTING.html).

This project is released with a [Contributor Code of
Conduct](https://oxford-ihtm.io/washdata/CODE_OF_CONDUCT.html). By
Conduct](https://katilingban.io/washdata/CODE_OF_CONDUCT.html). By
participating in this project you agree to abide by its terms.
Loading