update citation

openwashdata · May 2, 2024 · 3b8ab00 · 3b8ab00
1 parent 106eb6b
commit 3b8ab00
Show file tree

Hide file tree

Showing 180 changed files with 6,454 additions and 83 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,7 +1,7 @@
-# -----------------------------------------------------------
-# CITATION file created with {cffr} R package, v0.5.0
+# --------------------------------------------
+# CITATION file created with {cffr} R package
 # See also: https://docs.ropensci.org/cffr/
-# -----------------------------------------------------------
+# --------------------------------------------
 
 cff-version: 1.2.0
 message: 'To cite package "waterpumpkwale" in publications use:'
@@ -10,6 +10,7 @@ license: CC-BY-4.0
 title: 'waterpumpkwale: Weekly volume of water pumped for handpumps monitored with
   Smart Handpump technology, Kwale County, Kenya'
 version: 0.0.1
+doi: 10.5281/zenodo.8399887
 abstract: A dataset contains a summary of the weekly volumetric output of pumps monitored
   using Smart Handpump sensors for 2014 and 2015 in Kwale County of Kenya.
 authors:
@@ -29,16 +30,4 @@ contact:
   given-names: Mian
   email: mzhong@ethz.ch
   orcid: https://orcid.org/0009-0009-4546-7214
-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
-  location:
-    name: Vienna, Austria
-  year: '2023'
-  institution:
-    name: R Foundation for Statistical Computing
-  version: '>= 2.10'
+
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -16,7 +16,7 @@ Description: A dataset contains a summary of the weekly volumetric output of pum
 License: CC BY 4.0
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Depends: 
     R (>= 2.10)
 LazyData: true

diff --git a/R/weeklyvol2015.R b/R/weeklyvol2015.R
@@ -1,6 +1,7 @@
 #' Weekly volume in year 2015
 #'
 #' @format A tibble with 297 rows and 53 variables
+#'
 #'\describe{
 #'   \item{PumpID}{ID number of the water pump}
 #'   \item{n}{Each column indicates the week number 1, 2, 3, ..., 52}

diff --git a/README.md b/README.md
@@ -139,18 +139,20 @@ the following information to give credits for authors of the dataset!
 citation("waterpumpkwale")
 #> To cite package 'waterpumpkwale' in publications use:
 #> 
-#>   Thomson P, Hope R, Foster T, Zhong M (2023). _waterpumpkwale: Weekly
+#>   Thomson P, Hope R, Foster T, Zhong M (2023). "waterpumpkwale: Weekly
 #>   volume of water pumped for handpumps monitored with Smart Handpump
-#>   technology, Kwale County, Kenya_. R package version 0.0.1.
+#>   technology, Kwale County, Kenya." doi:10.5281/zenodo.8399887
+#>   <https://doi.org/10.5281/zenodo.8399887>.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
-#>   @Manual{,
-#>     title = {waterpumpkwale: Weekly volume of water pumped for handpumps monitored with Smart Handpump
-#> technology, Kwale County, Kenya},
+#>   @Misc{thomson_etall:2023,
+#>     title = {waterpumpkwale: Weekly volume of water pumped for handpumps monitored with Smart Handpump technology, Kwale County, Kenya},
 #>     author = {Patrick Thomson and Rob Hope and Tim Foster and Mian Zhong},
 #>     year = {2023},
-#>     note = {R package version 0.0.1},
+#>     doi = {10.5281/zenodo.8399887},
+#>     abstract = {A dataset contains a summary of the weekly volumetric output of pumps monitored using Smart Handpump sensors for 2014 and 2015 in Kwale County of Kenya.},
+#>     version = {0.0.1},
 #>   }
 ```
 

diff --git a/data-raw/~$WDT_Weekly_Volume_ARCH.xlsx b/data-raw/~$WDT_Weekly_Volume_ARCH.xlsx
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html