diff --git a/.Rbuildignore b/.Rbuildignore index 82d8eb4..709f107 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,4 @@ ^docs$ ^pkgdown$ ^CITATION\.cff$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..a3ac618 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -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 diff --git a/.gitignore b/.gitignore index c39c9d6..df127e1 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ .DS_Store .quarto + diff --git a/README.Rmd b/README.Rmd index ffe8b2e..3d33299 100644 --- a/README.Rmd +++ b/README.Rmd @@ -21,6 +21,8 @@ library(cleanteamghana) # cleanteamghana +[![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) 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. diff --git a/README.md b/README.md index 8fab9ab..99e6f77 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ # cleanteamghana + +[![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) This package contains compiled data utilized in a research paper @@ -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 @@ -285,7 +288,7 @@ ggplot(satisfaction_means, aes(x = Satisfaction_Category, y = Mean_Score)) + -## License +## License Data are available as [CC-BY](https://github.com/openwashdata/cleanteamghana/LICENSE.md). @@ -293,22 +296,22 @@ Data are available as ## 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}, #> } ``` diff --git a/_pkgdown.yml b/_pkgdown.yml index d71acfb..f7263d5 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,26 @@ -url: ~ +url: https://github.com/openwashdata/cleanteamghana/blob/main/_pkgdown.yml + template: bootstrap: 5 + includes: + in_header: | + + +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!" diff --git a/docs/LICENSE.html b/docs/LICENSE.html index b0c0b07..69fc084 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -2,7 +2,7 @@ NA • cleanteamghana + Skip to contents @@ -171,7 +171,7 @@