diff --git a/.Rbuildignore b/.Rbuildignore
index 4da9030..c510b70 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -3,3 +3,10 @@
^data-raw$
^LICENSE\.md$
^README\.Rmd$
+^CITATION\.cff$
+^CLAUDE\.md$
+^_pkgdown\.yml$
+^docs$
+^\.github$
+^\.claude$
+^vignettes/articles$
diff --git a/DESCRIPTION b/DESCRIPTION
index a40f319..fa75293 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -19,6 +19,15 @@ Imports:
dplyr,
readxl,
openxlsx
+Suggests:
+ gt,
+ gtExtras,
+ ggplot2,
+ tidyverse,
+ knitr,
+ rmarkdown,
+ scales
+VignetteBuilder: knitr
Date: 2025-06-02
URL: https://github.com/openwashdata/artesianwells
BugReports: https://github.com/openwashdata/artesianwells/issues
diff --git a/NAMESPACE b/NAMESPACE
index 6ae9268..a06b9ab 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,2 +1,6 @@
# Generated by roxygen2: do not edit by hand
+importFrom(dplyr,"%>%")
+importFrom(openxlsx,write.xlsx)
+importFrom(readr,read_csv)
+importFrom(readxl,read_excel)
diff --git a/R/artesianwells.R b/R/artesianwells.R
index ae0e311..1fa3585 100644
--- a/R/artesianwells.R
+++ b/R/artesianwells.R
@@ -47,4 +47,9 @@
#'
#' # Summary of districts
#' table(artesianwells$district)
+#'
+#' @importFrom dplyr %>%
+#' @importFrom readr read_csv
+#' @importFrom readxl read_excel
+#' @importFrom openxlsx write.xlsx
"artesianwells"
diff --git a/README.Rmd b/README.Rmd
index 3070f3b..61d0934 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -59,6 +59,41 @@ This dataset is complemented by images captured at each site, accessible
via permanent URLs, which provide photographic evidence of physical and
infrastructural conditions.
+## At a Glance
+
+```{r district-summary, echo=FALSE, message=FALSE}
+library(artesianwells)
+library(dplyr)
+library(gt)
+artesianwells |>
+ group_by(district) |>
+ summarise(
+ well_count = n(),
+ avg_fill_time = round(mean(seconds_to_fill_20L, na.rm = TRUE), 1),
+ wells_with_images = sum(!is.na(well_images)),
+ .groups = "drop"
+ ) |>
+ arrange(desc(well_count)) |>
+ gt::gt() |>
+ gt::cols_label(
+ district = "District",
+ well_count = "Total Wells",
+ avg_fill_time = "Avg. Fill Time (s)",
+ wells_with_images = "Wells with Images"
+ ) |>
+ gt::tab_header(
+ title = "Artesian Wells by District",
+ subtitle = "Summary of 44 documented well sites"
+ ) |>
+ gt::fmt_number(
+ columns = avg_fill_time,
+ decimals = 1
+ ) |>
+ gt::as_raw_html()
+```
+
+📸 **[View the Image Gallery](https://openwashdata.github.io/artesianwells/articles/image-gallery.html)** - Explore photographs from all 43 documented well sites with interactive tables and visualizations.
+
**Potential Use Cases**
Water Resource Planning and Management Government bodies and NGOs can
@@ -158,6 +193,19 @@ readr::read_csv("data-raw/dictionary.csv") |>
kableExtra::scroll_box(height = "200px")
```
+## Use Cases
+
+### Visual Documentation and Analysis
+
+The package includes a comprehensive [**Image Gallery**](https://openwashdata.github.io/artesianwells/articles/image-gallery.html) vignette that showcases photographs from 43 artesian well sites. This visual documentation helps:
+
+- **Field verification**: Compare physical infrastructure with reported data
+- **Condition assessment**: Evaluate well structures and surrounding environments
+- **Training materials**: Use real-world examples for capacity building
+- **Stakeholder communication**: Present tangible evidence to decision-makers
+
+The gallery organizes wells by district and displays key metrics alongside images, making it easy to identify patterns and prioritize interventions.
+
## Example
```{r}
diff --git a/README.md b/README.md
index 19597df..5f30f11 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,79 @@ This dataset is complemented by images captured at each site, accessible
via permanent URLs, which provide photographic evidence of physical and
infrastructural conditions.
+## At a Glance
+
+
+
+
+
+
Artesian Wells by District
+
+
+
Summary of 44 documented well sites
+
+
+
District
+
Total Wells
+
Avg. Fill Time (s)
+
Wells with Images
+
+
+
+
Machinga
+
10
+
62.9
+
10
+
Mangochi
+
8
+
58.2
+
8
+
Blantyre
+
5
+
104.9
+
5
+
Chikwawa
+
4
+
17.8
+
4
+
Ntchisi
+
4
+
38.8
+
4
+
Karonga
+
3
+
37.2
+
3
+
Neno
+
3
+
0.0
+
3
+
Salima
+
3
+
18.6
+
3
+
Balaka
+
2
+
153.7
+
2
+
Liwonde
+
1
+
0.0
+
1
+
Mwanza
+
1
+
0.0
+
0
+
+
+
+
+
+📸 **[View the Image
+Gallery](https://openwashdata.github.io/artesianwells/articles/image-gallery.html)** -
+Explore photographs from all 43 documented well sites with interactive
+tables and visualizations.
+
**Potential Use Cases**
Water Resource Planning and Management Government bodies and NGOs can
@@ -113,7 +186,7 @@ artesianwells |>
gt::as_raw_html()
```
-
+
@@ -829,6 +902,27 @@ Type of management in place for the water source if Other is selected
+## Use Cases
+
+### Visual Documentation and Analysis
+
+The package includes a comprehensive [**Image
+Gallery**](https://openwashdata.github.io/artesianwells/articles/image-gallery.html)
+vignette that showcases photographs from 43 artesian well sites. This
+visual documentation helps:
+
+- **Field verification**: Compare physical infrastructure with reported
+ data
+- **Condition assessment**: Evaluate well structures and surrounding
+ environments
+- **Training materials**: Use real-world examples for capacity building
+- **Stakeholder communication**: Present tangible evidence to
+ decision-makers
+
+The gallery organizes wells by district and displays key metrics
+alongside images, making it easy to identify patterns and prioritize
+interventions.
+
## Example
``` r
diff --git a/_pkgdown.yml b/_pkgdown.yml
index abf4d24..c3a92e5 100644
--- a/_pkgdown.yml
+++ b/_pkgdown.yml
@@ -4,6 +4,15 @@ template:
includes:
in_header: |
+
+navbar:
+ structure:
+ left: [intro, reference, articles]
+ right: [search, github]
+ components:
+ articles:
+ text: Gallery
+ href: articles/image-gallery.html
home:
links:
@@ -31,3 +40,9 @@ reference:
desc: "Access the artesianwells dataset"
contents:
- artesianwells
+
+articles:
+- title: "Gallery"
+ navbar: ~
+ contents:
+ - articles/image-gallery
diff --git a/docs/404.html b/docs/404.html
index 3dede47..ff6fc7c 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -31,7 +31,7 @@