Skip to content

Request for Dataset review#1

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

Request for Dataset review#1
larnsce merged 14 commits into
mainfrom
dev

Conversation

@emmanuellmhango

Copy link
Copy Markdown
Collaborator

Dear Colin

Kindly review the pull request. I have done the following:

  • created and initialized the git repo
  • added the artessian well dataset
  • cleaned the data and added a map visualization
  • created the description and the readme.

Kindly note that i pushed to the DEV branch before initialized the main branch.

Kind regards

@larnsce larnsce requested review from larnsce and removed request for bonschorno July 3, 2025 08:53
larnsce added 13 commits July 4, 2025 11:30
- Rename trad_auth to traditional_authority
- Rename structure_type to well_structure_type
- Rename structure_type_other to well_structure_type_other
- Rename fill_time_20l to seconds_to_fill_20L
- Rename community_use to use_of_site
…cumentation

- Remove ggplot2 and maps packages (not needed for data processing)
- Add descriptive comments explaining each processing step
- Document the purpose of each data export format
- Note final dataset dimensions (44 wells, 29 variables)
- Create R-CMD-check.yaml workflow to test on multiple R versions and OS
- Configure to run on push and PR to main, master, and dev branches
- Add R-CMD-check badge to README.Rmd
- Test on Ubuntu (release, oldrel, devel), macOS, and Windows
- Add examples showing how to load and explore the dataset
- Include examples for viewing data, checking dimensions, and summarizing districts
- Regenerate documentation with devtools::document()
- All examples tested and working correctly
- Add placeholder ORCID ID (0000-0000-0000-0000) for @emmanuellmhango
- Add missing package dependencies: readr, dplyr, readxl, openxlsx
- These packages are used in data_processing.R

@emmanuellmhango Please update with your actual ORCID ID
- Add CITATION.cff following CFF v1.2.0 format
- Add inst/CITATION for R package citation
- Include placeholder ORCID ID pending update from @emmanuellmhango
- Set up proper citation structure for future DOI integration
- Replace placeholder ORCID (0000-0000-0000-0000) with actual ORCID (0000-0003-3197-6244)
- Update ORCID in DESCRIPTION and CITATION.cff
- Fix year in inst/CITATION from 2024 to 2025 to match CITATION.cff date
Fix Issue #2: General Information & Metadata
- Create _pkgdown.yml with openwashdata template and Plausible analytics
- Fix license link in README.Rmd (removed placeholder)
- Update Roxygen documentation variable names to match dictionary.csv
- Regenerate documentation and README.md
- Successfully build pkgdown site
@larnsce

larnsce commented Jul 6, 2025

Copy link
Copy Markdown
Contributor

Dear @emmanuellmhango, thank you for preparing the artesianwells data package - this valuable dataset documenting 44 artesian well sites across Malawi will support water resource planning and research. The package has passed all review checks and is ready to be merged to main for publication.

@larnsce larnsce merged commit e150f60 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.

2 participants