Skip to content

Commit

Permalink
added DOI badge
Browse files Browse the repository at this point in the history
  • Loading branch information
sskorik01 committed Dec 28, 2023
1 parent ed2bff7 commit ee90bc4
Show file tree
Hide file tree
Showing 10 changed files with 123 additions and 21 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
^docs$
^pkgdown$
^CITATION\.cff$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
49 changes: 49 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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:
branches: [main, master]

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@v3

- 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
.DS_Store
.quarto


2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ library(cleanteamghana)
# cleanteamghana

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

This package contains compiled data utilized in a research paper examining the user experience of the Clean Team Ghana's container-based sanitation service in Kumasi, Ghana.
Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
# cleanteamghana

<!-- badges: start -->

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

This package contains compiled data utilized in a research paper
Expand Down Expand Up @@ -72,7 +75,7 @@ The package provides access to a single data set.
library(cleanteamghana)
```

The `cleanteamghana` data set has 127 variables and 583 observations.
The `cleanteamghana` data set has 128 variables and 583 observations.
For an overview of the variable names, see the following table.

``` r
Expand Down Expand Up @@ -285,30 +288,30 @@ ggplot(satisfaction_means, aes(x = Satisfaction_Category, y = Mean_Score)) +

<img src="man/figures/README-unnamed-chunk-7-1.png" width="100%" />

## License
## License

Data are available as
[CC-BY](https://github.com/openwashdata/cleanteamghana/LICENSE.md).

## Citation

To cite this package, please use:

``` r
citation("cleanteamghana")
#> Um Paket 'cleanteamghana' in Publikationen zu zitieren, nutzen Sie
#> bitte:
#>
#> Skorik S (2023). "cleanteamghana: What the Package Does (One Line,
#> Title Case)."
#> Skorik S, Tidwell J, Nyarko K, Ross I, Dwumfour-Asare B, Pippa S
#> (2023). "cleanteamghana: Clean Team Ghana."
#>
#> Ein BibTeX-Eintrag für LaTeX-Benutzer ist
#>
#> @Misc{skorik,
#> title = {cleanteamghana: What the Package Does (One Line, Title Case)},
#> author = {Sophia Skorik},
#> @Misc{skoriktidwell,
#> title = {cleanteamghana: Clean Team Ghana},
#> author = {Sophia Skorik and James Benjamin Tidwell and Kwabena Biritwum Nyarko and Ian Ross and Bismark Dwumfour-Asare and Scott Pippa},
#> year = {2023},
#> abstract = {What the package does (one paragraph).},
#> abstract = {This package compiles user experience data for the Clean Team Ghana container-based sanitation service in Kumasi, Ghana.},
#> version = {0.0.0.9000},
#> }
```
24 changes: 23 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
url: ~
url: https://github.com/openwashdata/cleanteamghana/blob/main/_pkgdown.yml

template:
bootstrap: 5
includes:
in_header: |
<script defer data-domain="openwashdata.github.io/" src="https://plausible.io/js/script.js"></script>
home:
links:
- icon: github
text: GitHub repository
href: https://github.com/openwashdata/cleanteamghana
sidebar:
structure: [links, citation, authors, dev, custom]
components:
custom:

authors:
footer:
roles: [cre, fnd]
text: "Crafted by"
sidebar:
roles: [cre, aut, ctb]
before: "So *who* does the work?"
after: "Thanks all!"
4 changes: 2 additions & 2 deletions docs/LICENSE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 28 additions & 8 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,8 @@ pandoc: 3.1.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
last_built: 2023-10-25T08:39Z
last_built: 2023-12-28T15:30Z
urls:
reference: https://github.com/openwashdata/cleanteamghana/blob/main/_pkgdown.yml/reference
article: https://github.com/openwashdata/cleanteamghana/blob/main/_pkgdown.yml/articles

0 comments on commit ee90bc4

Please sign in to comment.