Merge pull request #9 from openwashdata/4-data-package-review-documentation

Fix Issue #4: Documentation

Author: larnsce

R/artesianwells.R

@@ -9,14 +9,14 @@
 #'   \item{longitude}{Longitude coordinate of the surveyed site}
 #'   \item{artesian_well}{Indicates whether the location of the artesian well}
 #'   \item{district}{Administrative district where the site is located}
-#'   \item{trad_auth}{Traditional authority under which the site falls}
+#'   \item{traditional_authority}{Traditional authority under which the site falls}
 #'   \item{well_images}{Links or filenames of images showing the well}
 #'   \item{has_structure}{Indicates if the well has a surrounding structure}
-#'   \item{structure_type}{Type of structure present around the well}
-#'   \item{structure_type_other}{Description of structure if Other is selected}
+#'   \item{well_structure_type}{Type of structure present around the well}
+#'   \item{well_structure_type_other}{Description of structure if Other is selected}
 #'   \item{can_test_flow}{Indicates if a flow test can be conducted at the site}
-#'   \item{fill_time_20l}{Time in seconds required to fill a 20 liter container}
-#'   \item{community_use}{Primary community usage of the water source}
+#'   \item{seconds_to_fill_20L}{Time in seconds required to fill a 20 liter container}
+#'   \item{use_of_site}{Primary community usage of the water source}
 #'   \item{other_site_use}{Additional uses of the site (if any)}
 #'   \item{seasonal_unavail}{Indicates if the site becomes unavailable during certain seasons}
 #'   \item{area_photos}{Links or filenames of photos showing the broader site area}

README.Rmd

@@ -190,7 +190,7 @@ ggplot() +
 ## License
 
 Data are available as
-[CC-BY](https://github.com/openwashdata/%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md).
+[CC-BY](https://github.com/openwashdata/artesianwells/blob/main/LICENSE.md).
 
 ## Citation
 

README.md

@@ -112,7 +112,7 @@ artesianwells |>
   gt::as_raw_html()
 ```
 
-<div id="iypvyonzrr" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
+<div id="pewlrhwbgt" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
   &#10;  <table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false" style="-webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; font-family: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3;" bgcolor="#FFFFFF">
   <thead style="border-style: none;">
     <tr class="gt_col_headings" style="border-style: none; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3;">
@@ -863,7 +863,7 @@ ggplot() +
 ## License
 
 Data are available as
-[CC-BY](https://github.com/openwashdata/%7B%7B%7Bpackagename%7D%7D%7D/blob/main/LICENSE.md).
+[CC-BY](https://github.com/openwashdata/artesianwells/blob/main/LICENSE.md).
 
 ## Citation
 
@@ -874,17 +874,18 @@ citation("artesianwells")
 #> Um Paket 'artesianwells' in Publikationen zu zitieren, nutzen Sie
 #> bitte:
 #> 
-#>   Mhango E (2025). _artesianwells: Artesian Well Site Assessment Data_.
-#>   R package version 0.0.0.9000,
+#>   Mhango E (2025). "artesianwells: Artesian Well Site Assessment Data."
 #>   <https://github.com/openwashdata/artesianwells>.
 #> 
 #> Ein BibTeX-Eintrag für LaTeX-Benutzer ist
 #> 
-#>   @Manual{,
+#>   @Misc{,
 #>     title = {artesianwells: Artesian Well Site Assessment Data},
 #>     author = {Emmanuel Mhango},
 #>     year = {2025},
-#>     note = {R package version 0.0.0.9000},
 #>     url = {https://github.com/openwashdata/artesianwells},
+#>     abstract = {A dataset capturing geospatial, structural, usage, and management characteristics of artesian well sites.},
+#>     version = {0.0.0.9000},
+#>     type = {dataset},
 #>   }
 ```

_pkgdown.yml

@@ -0,0 +1,33 @@
+url: https://github.com/openwashdata/artesianwells
+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/artesianwells
+  sidebar:
+    structure: [links, citation, authors, dev, custom]
+    components:
+      custom:
+        title: Funding
+        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:
+    roles: [cre, fnd]
+    text: "Crafted by"
+  sidebar:
+    roles: [cre, aut, ctb]
+    before: "So *who* does the work?"
+    after: "Thanks all!"
+
+reference:
+- title: "Data"
+  desc: "Access the artesianwells dataset"
+  contents:
+  - artesianwells