update readme and funding info

DESCRIPTION

@@ -7,10 +7,11 @@ Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
 Authors@R: c(
-    person("Mian", "Zhong", , "mzhong@ethz.ch", role = c("aut", "cre"),
+    person("Sebastian Camilo", "Loos", , "sloos@ethz.ch", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0002-8830-1734")),
+           person("Mian", "Zhong", , "mzhong@ethz.ch", role = "aut",
            comment = c(ORCID = "0009-0009-4546-7214")),
-    person("Sebastian Camilo", "Loos", , "sloos@ethz.ch", role = "aut",
-           comment = c(ORCID = "0000-0002-8830-1734"))
+           person("Rob", "Hope", role = "aut")
   )
 URL: https://github.com/openwashdata/grdwtrsmpkwale
 BugReports: https://github.com/openwashdata/grdwtrsmpkwale/issues

README.Rmd

@@ -35,6 +35,7 @@ library(tmaptools)
 [![License: CC BY
 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
 [![R-CMD-check](https://github.com/openwashdata/grdwtrsmpkwale/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/grdwtrsmpkwale/actions/workflows/R-CMD-check.yaml)
+
 <!-- badges: end -->
 
 The goal of `grdwtrsmpkwale` is to provide datasets for research and
@@ -71,6 +72,21 @@ read_csv("data-raw/dictionary.csv") |>
 
 ```
 
+# Introduction
+
+This dataset contains results of two sampling campaigns conducted in
+Kwale County Kenya in March and June 2016 by GHS/UPC as part of the Gro
+for GooD project.[^1]
+
+[^1]: <https://metadata.bgs.ac.uk/geonetwork/srv/eng/catalog.search#/metadata/50cdcbae-bc14-628b-e054-002128a47908>
+
+Water samples from over 79 groundwater and 6 surface water (SW)
+locations were analysed for major ions, stable isotopes, selected trace
+constituents, electrical conductivity, nitrates, ammonia, pH, DO
+(Dissolved Oxygen), Eh (oxidation / reduction potential), Temperature,
+TOC (Total Organic Carbon) and field alkalinity. Most locations were
+sampled in both March (dry season) and June (wet season).
+
 # Data
 
 This data package has two datasets: `water_samples` and
@@ -82,7 +98,14 @@ library(grdwtrsmpkwale)
 
 ## water_samples
 
-This dataset contains data from an analysis of groundwater in Kwale, Kenya. The data was collected once in March and once in June of 2016 for each sampling spot. In total `r nrow(water_samples)` samples were taken in `r nrow(distinct(water_samples, localization))` different localisations that have their geospatial data included in this data package. The sample analysis includes different measurements including conductivity, temperature, pH-values and concentrations of different elements/molecules for the groundwater samples.
+This dataset contains data from an analysis of groundwater in Kwale,
+Kenya. The data was collected once in March and once in June of 2016 for
+each sampling spot. In total `r nrow(water_samples)` samples were taken
+in `r nrow(distinct(water_samples, localization))` different
+localisations that have their geospatial data included in this data
+package. The sample analysis includes different measurements including
+conductivity, temperature, pH-values and concentrations of different
+elements/molecules for the groundwater samples.
 
 The `water_samples` data set has `r ncol(water_samples)` variables and
 `r nrow(water_samples)` observations. For an overview of the variable
@@ -119,9 +142,13 @@ sf_samples |>
 
 ```
 
-##  selected_samples
+## selected_samples
 
-This dataset contains data from an analysis of groundwater in Kwale, Kenya. The data was collected three weeks in a row at 8 different locations. The sample analysis includes measurements of conductivity, temperature, pH-values and concentrations of different elements/molecules.
+This dataset contains data from an analysis of groundwater in Kwale,
+Kenya. The data was collected three weeks in a row at 8 different
+locations. The sample analysis includes measurements of conductivity,
+temperature, pH-values and concentrations of different
+elements/molecules.
 
 The `selected_samples` data set has `r ncol(selected_samples)` variables
 and `r nrow(selected_samples)` observations. For an overview of the
@@ -174,6 +201,13 @@ Data are available as
 citation("grdwtrsmpkwale")
 ```
 
-## Related References (TBD)
-
+## Related References
 
+[First step to understand the importance of new deep aquifer pumping
+regime in groundwater system in a developing country, Kwale,
+Kenya](http://meetingorganizer.copernicus.org/EGU2016/EGU2016-16969.pdf);
+Ferrer et al, Geophysical Research Abstracts, Vol. 18, EGU2016-16969,
+2016;
+<https://upgro.files.wordpress.com/2015/09/egu16_groforgood_v1.pdf>;
+UPC - The Departement of Civil Enginyering de la Universitat Politecnica
+de Catalunya GHS - Grupo de Hidrologia Subterranea

README.md

@@ -8,6 +8,7 @@
 [![License: CC BY
 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
 [![R-CMD-check](https://github.com/openwashdata/grdwtrsmpkwale/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/grdwtrsmpkwale/actions/workflows/R-CMD-check.yaml)
+
 <!-- badges: end -->
 
 The goal of `grdwtrsmpkwale` is to provide datasets for research and
@@ -33,6 +34,19 @@ file from the table below.
 | water_samples    | [Download CSV](https://github.com/openwashdata/grdwtrsmpkwale/raw/main/inst/extdata/water_samples.csv)    | [Download XLSX](https://github.com/openwashdata/grdwtrsmpkwale/raw/main/inst/extdata/water_samples.xlsx)    |
 | selected_samples | [Download CSV](https://github.com/openwashdata/grdwtrsmpkwale/raw/main/inst/extdata/selected_samples.csv) | [Download XLSX](https://github.com/openwashdata/grdwtrsmpkwale/raw/main/inst/extdata/selected_samples.xlsx) |
 
+# Introduction
+
+This dataset contains results of two sampling campaigns conducted in
+Kwale County Kenya in March and June 2016 by GHS/UPC as part of the Gro
+for GooD project.[^1]
+
+Water samples from over 79 groundwater and 6 surface water (SW)
+locations were analysed for major ions, stable isotopes, selected trace
+constituents, electrical conductivity, nitrates, ammonia, pH, DO
+(Dissolved Oxygen), Eh (oxidation / reduction potential), Temperature,
+TOC (Total Organic Carbon) and field alkalinity. Most locations were
+sampled in both March (dry season) and June (wet season).
+
 # Data
 
 This data package has two datasets: `water_samples` and
@@ -2720,17 +2734,28 @@ Data are available as
 
     #> To cite package 'grdwtrsmpkwale' in publications use:
     #> 
-    #>   Zhong M, Loos S (????). _grdwtrsmpkwale: Groundwater analysis from
-    #>   2016 in Kwale, Kenya_. R package version 0.0.0.9000,
+    #>   Loos S, Zhong M, Hope R (????). _grdwtrsmpkwale: Groundwater analysis
+    #>   from 2016 in Kwale, Kenya_. R package version 0.0.0.9000,
     #>   <https://github.com/openwashdata/grdwtrsmpkwale>.
     #> 
     #> A BibTeX entry for LaTeX users is
     #> 
     #>   @Manual{,
     #>     title = {grdwtrsmpkwale: Groundwater analysis from 2016 in Kwale, Kenya},
-    #>     author = {Mian Zhong and Sebastian Camilo Loos},
+    #>     author = {Sebastian Camilo Loos and Mian Zhong and Rob Hope},
     #>     note = {R package version 0.0.0.9000},
     #>     url = {https://github.com/openwashdata/grdwtrsmpkwale},
     #>   }
 
-## Related References (TBD)
+## Related References
+
+[First step to understand the importance of new deep aquifer pumping
+regime in groundwater system in a developing country, Kwale,
+Kenya](http://meetingorganizer.copernicus.org/EGU2016/EGU2016-16969.pdf);
+Ferrer et al, Geophysical Research Abstracts, Vol. 18, EGU2016-16969,
+2016;
+<https://upgro.files.wordpress.com/2015/09/egu16_groforgood_v1.pdf>;
+UPC - The Departement of Civil Enginyering de la Universitat Politecnica
+de Catalunya GHS - Grupo de Hidrologia Subterranea
+
+[^1]: <https://metadata.bgs.ac.uk/geonetwork/srv/eng/catalog.search#/metadata/50cdcbae-bc14-628b-e054-002128a47908>

_pkgdown.yml

@@ -16,7 +16,7 @@ home:
     components:
       custom:
         title: Funding
-        text: This project was funded by the [Global Health Engineering group at ETH Zurich](https://ghe.ethz.ch/) & supported by the [Open Research Data Program of the ETH Board](https://ethrat.ch/en/eth-domain/open-research-data/).
+        text: This project was funded by the [Open Research Data Program of the ETH Board](https://ethrat.ch/en/eth-domain/open-research-data/).
 
 authors:
   footer: