Skip to content

Add image gallery vignette for artesian wells#12

Merged
larnsce merged 5 commits into
devfrom
10-create-visual-showcase-vignette-with-artesian-well-images
Jul 6, 2025
Merged

Add image gallery vignette for artesian wells#12
larnsce merged 5 commits into
devfrom
10-create-visual-showcase-vignette-with-artesian-well-images

Conversation

@larnsce

@larnsce larnsce commented Jul 6, 2025

Copy link
Copy Markdown
Contributor

Summary

Implements Issue #10 - Create visual showcase vignette with artesian well images

Changes Made

  • Created Quarto vignette
  • Displays mwater API images in organized gt tables by district
  • Implements 4-column responsive image grid with CSS styling
  • Includes data visualizations for usage patterns and flow rates
  • Added necessary package dependencies to DESCRIPTION
  • Configured _pkgdown.yml to include the new article

Features

  • District-based organization: Wells grouped by district with summary statistics
  • Image tables: Uses gt package to display images alongside key data points
  • Flow rate analysis: Color-coded flow rates (Fast/Moderate/Slow)
  • Image grid: Quick visual overview with 40 images in a 4-column layout
  • Responsive design: Adapts to mobile screens (2 columns on tablet, 1 on phone)
  • Usage patterns: Bar chart showing primary uses of wells

Technical Details

  • Uses tidyverse for data manipulation
  • gt and gtExtras for advanced table formatting
  • CSS grid for responsive image layout
  • Extracts first image from semicolon-separated URLs
  • Handles missing data gracefully
  • Uses pwalk() to avoid NULL output in console

Example Output

The vignette displays:

  • 43 wells with images across multiple districts
  • Average fill times by district
  • Color-coded flow rate indicators
  • Primary usage distribution
  • Coordinates and management information

Closes #10

larnsce added 5 commits July 6, 2025 20:58
- Create vignettes/articles directory structure
- Add image-gallery.qmd Quarto vignette
- Display images in gt tables organized by district
- Include 4-column image grid with CSS styling
- Add flow rate analysis and usage pattern visualizations
- Update DESCRIPTION with Suggests dependencies (gt, gtExtras, etc.)
- Configure _pkgdown.yml to include the article
- Add .gitignore for generated vignette files

The vignette extracts images from mwater API URLs and presents them
alongside key data points including location, flow rates, usage patterns,
and management information.
- Replace pmap() with pwalk() to avoid NULL output in image grid
- Remove Session Info section from vignette
- Cleaner output without unnecessary [[1]] NULL messages
- Add 'At a Glance' section with district summary table at the beginning
- Create 'Use Cases' section highlighting the image gallery vignette
- Update navbar in _pkgdown.yml to include Gallery link
- Emphasize visual documentation benefits for stakeholders
- Include summary statistics: wells per district, average fill times, image counts
- Include ORCID ID and email
- Add affiliation to Global Health Engineering, ETH Zurich
- Include GHE website URL
- Add VignetteBuilder: knitr to DESCRIPTION
- Add vignettes/articles to .Rbuildignore (pkgdown-specific)
- Update .Rbuildignore to exclude non-standard files
- Add @importFrom statements to use imported packages
- Update vignettes/.gitignore to exclude generated files
- Package now passes R CMD check with 0 errors, 0 warnings, 0 notes
@larnsce larnsce merged commit db2cc8b into dev Jul 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant