add citation file placeholder

.Rbuildignore

@@ -6,3 +6,5 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^CITATION\.cff$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,52 @@
+# 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.yaml
+
+permissions: read-all
+
+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","--compact-vignettes=gs+qpdf")'

CITATION.cff

@@ -0,0 +1,54 @@
+# --------------------------------------------
+# CITATION file created with {cffr} R package
+# See also: https://docs.ropensci.org/cffr/
+# --------------------------------------------
+
+cff-version: 1.2.0
+message: 'To cite package "watercostaccra" in publications use:'
+type: software
+license: CC-BY-4.0
+title: 'watercostaccra: Household water costs and coping strategies data from metropolitan
+  Accra'
+version: 0.0.0.9000
+abstract: A household survey on water costs and coping strategies as well as a water
+  point survey were conducted in two low-income communities in metropolitan Accra.
+  These are Korle Gonno, a larger, well-planned coastal area with over 35 household
+  water vendors, and Abuja, a small, densely packed, extralegal settlement with 15
+  water vendor and bathhouse businesses.
+authors:
+- family-names: Vicario
+  given-names: Elizabeth
+  email: [email protected]
+  orcid: https://orcid.org/0009-0000-6081-2076
+- family-names: Götschmann
+  given-names: Margaux
+  email: [email protected]
+  orcid: https://orcid.org/0009-0002-2567-3343
+- family-names: Davidson
+  given-names: Betty Avanu
+  email: [email protected]
+  orcid: https://orcid.org/0009-0006-9594-4048
+- family-names: Amankwaa
+  given-names: Ebenezer F.
+  email: [email protected]
+  orcid: https://orcid.org/0000-0002-8735-2521
+- family-names: Zhong
+  given-names: Mian
+  email: [email protected]
+  orcid: https://orcid.org/0009-0009-4546-7214
+repository-code: https://github.com/openwashdata/watercostaccra
+url: https://github.com/openwashdata/watercostaccra
+contact:
+- family-names: Götschmann
+  given-names: Margaux
+  email: [email protected]
+  orcid: https://orcid.org/0009-0002-2567-3343
+keywords:
+- accra
+- ghana
+- household-surveys
+- open-data
+- openwashdata
+- r
+- water-cost
+

DESCRIPTION

@@ -2,10 +2,10 @@ Package: watercostaccra
 Title: Household water costs and coping strategies data from metropolitan Accra
 Version: 0.0.0.9000
 Authors@R: c(
-    person("Margaux", "Götschmann", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0009-0002-2567-3343")),
     person("Elizabeth", "Vicario", , "[email protected]", role = "aut",
            comment = c(ORCID = "0009-0000-6081-2076")),
+    person("Margaux", "Götschmann", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0009-0002-2567-3343")),
     person("Betty Avanu", "Davidson", , "[email protected]", role = "aut",
            comment = c(ORCID = "0009-0006-9594-4048")),
     person("Ebenezer F.", "Amankwaa", , "[email protected]", role = "aut",

README.Rmd

@@ -28,7 +28,7 @@ knitr::opts_chunk$set(
 
 [![License: CC BY
 4.0](https://img.shields.io/badge/License-CC_BY_4.0-pink.svg)](https://creativecommons.org/licenses/by/4.0/)
-
+[![R-CMD-check](https://github.com/openwashdata/watercostaccra/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/watercostaccra/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of watercostaccra is to provide users with documentation on two surveys on household water costs, coping mechanisms as well as water point estimates conducted in November 2023 in Accra, Ghana. The data sets are associated with the following [project report](https://ds4owd-001.github.io/project-efvicario/) completed by Elizabeth Vicario for the ["data science for openwashdata" course](https://ds4owd-001.github.io/website/) offered by [openwashdata.org](https://openwashdata.org/).

README.md

@@ -981,17 +981,21 @@ citation("watercostaccra")
 #> To cite package 'watercostaccra' in publications use:
 #> 
 #>   Götschmann M, Vicario E, Davidson B, Amankwaa E, Zhong M (2024).
-#>   _watercostaccra: Household water costs and coping strategies data
-#>   from metropolitan Accra_. R package version 0.0.0.9000,
+#>   "watercostaccra: Household water costs and coping strategies data
+#>   from metropolitan Accra." doi:10.5281/zenodo.6470427
+#>   <https://doi.org/10.5281/zenodo.6470427>,
 #>   <https://github.com/openwashdata/watercostaccra>.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
-#>   @Manual{,
+#>   @Misc{gotschmann_etall:2024,
 #>     title = {watercostaccra: Household water costs and coping strategies data from metropolitan Accra},
 #>     author = {Margaux Götschmann and Elizabeth Vicario and Betty Avanu Davidson and Ebenezer F. Amankwaa and Mian Zhong},
 #>     year = {2024},
-#>     note = {R package version 0.0.0.9000},
+#>     doi = {10.5281/zenodo.6470427},
 #>     url = {https://github.com/openwashdata/watercostaccra},
+#>     abstract = {A household survey on water costs and coping strategies as well as a water point survey were conducted in two low-income communities in metropolitan Accra. These are Korle Gonno, a larger, well-planned coastal area with over 35 household water vendors, and Abuja, a small, densely packed, extralegal settlement with 15 water vendor and bathhouse businesses.},
+#>     keywords = {accra,ghana,household-surveys,open-data,openwashdata,r,water-cost},
+#>     version = {0.0.0.9000},
 #>   }
 ```