Skip to content

Complete package review and add image gallery#13

Merged
larnsce merged 9 commits into
mainfrom
dev
Jul 6, 2025
Merged

Complete package review and add image gallery#13
larnsce merged 9 commits into
mainfrom
dev

Conversation

@larnsce

@larnsce larnsce commented Jul 6, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR completes the package review process and adds a comprehensive image gallery vignette.

Major Changes

📸 Image Gallery Vignette

  • Created interactive image gallery showcasing 43 artesian well sites
  • Displays well photographs from mwater API alongside key data
  • Organized by district with summary statistics
  • Includes flow rate analysis and usage pattern visualizations
  • Responsive 4-column grid layout for quick visual overview

📋 Package Review Completion

🌐 Website Enhancements

  • Added Gallery link to navigation menu
  • Highlighted image gallery in README "At a Glance" section
  • Built complete pkgdown site with all features

Features

  • Visual Documentation: 43 well sites with photographs
  • Interactive Tables: GT tables with color-coded flow rates
  • District Organization: Wells grouped by location
  • Responsive Design: Adapts to mobile/tablet screens
  • Data Integration: Images linked with coordinates, usage, and management info

Technical Details

  • Uses Quarto for vignette rendering
  • GT and gtExtras for advanced table formatting
  • CSS grid for responsive image layout
  • Proper R package structure following openwashdata standards

Release Info

  • Version 0.1.0 released with Zenodo DOI: 10.5281/zenodo.15824828
  • All documentation updated
  • Ready for deployment

Merges all completed work from the dev branch including resolved issues #2, #3, #4, #5, and #10.

larnsce added 9 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
…gnette-with-artesian-well-images

Add image gallery vignette for artesian wells
- Change article reference from 'image-gallery' to 'articles/image-gallery'
- Fixes pkgdown build error with hyphenated article names
- Add prominent link to image gallery after district summary table
- Use camera emoji to draw attention
- Emphasize interactive features and 43 documented sites
- Add image gallery article to docs/articles/
- Update all pkgdown site pages with new navigation
- Include gallery in navbar and article index
- Update .gitignore for Quarto files
@larnsce larnsce changed the title Add article Complete package review and add image gallery Jul 6, 2025
@larnsce larnsce merged commit 6c9c81b into main Jul 6, 2025
10 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