Merge: Full cleanup — remove placeholders, update docs, add .github config

Author: claude

.github/FUNDING.yml

@@ -1 +1,3 @@
-buy_me_a_coffee: varnasra
+buy_me_a_coffee: varnasr
+custom:
+  - "https://openstacks.dev/support.html"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug Report
+about: Report a bug in a script, notebook, or tool
+labels: bug
+---
+
+**Which script/notebook is affected?**
+
+**What happened?**
+
+**What did you expect?**
+
+**Steps to reproduce:**
+1.
+2.
+3.
+
+**Environment:**
+- R version:
+- OS:
+- Relevant packages:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,11 @@
+---
+name: Feature Request
+about: Suggest a new script, notebook, or improvement
+labels: enhancement
+---
+
+**What would you like?**
+
+**Why is this useful for field research/evaluation?**
+
+**Which section does this belong in?**

.github/ISSUE_TEMPLATE/repo-readiness-checklist.md

@@ -1,9 +1,16 @@
-# Changelog
+# FieldStack Changelog
 
-## [v1.0.0](https://github.com/Varnasr/FieldStack/tree/v1.0.0) (2025-04-19)
+## [v1.0.0] - 2025-04-19
 
-[Full Changelog](https://github.com/Varnasr/FieldStack/compare/954b918bc01299272877fe2d2b65194fcf7a7eed...v1.0.0)
-
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+### Initial Release
+- Core R scripts: health access index, climate vulnerability index, education outcomes, MEL reshaping
+- 4 Quarto notebooks for guided analysis workflows
+- Evaluation tools: SROI calculator, cost-effectiveness, qual-to-quant conversion
+- Custom visualisations: waterfall charts, bullet charts, sf maps
+- Qualitative coding with quanteda
+- Regression templates: logistic models, interaction terms, VIF checks
+- Sample datasets: climate exposure, health services, education outcomes, MEL indicators
+- Codebook templates for health surveys and programme monitoring
+- 9 testthat unit tests
+- GitHub Actions for CI and Quarto rendering
+- Zenodo DOI: 10.5281/zenodo.15250764

CHANGELOG.md

@@ -1,14 +1,13 @@
 cff-version: 1.2.0
 message: "If you use this repository, please cite it as below."
-title: "FieldStack: Reproducible R Code for MEL, Evaluation, and Social Data"
+title: "FieldStack: Reproducible R Code for Applied Development Research"
 version: "1.0.0"
 doi: "10.5281/zenodo.15250764"
 date-released: 2025-04-20
 authors:
   - family-names: Sri Raman
     given-names: Varna
-    orcid: "https://orcid.org/0000-0000-0000-0000"
-    affiliation: "Independent Development Economist"
 license: MIT
 repository-code: "https://github.com/Varnasr/FieldStack"
-url: "https://doi.org/10.5281/zenodo.15250764"
+url: "https://openstacks.dev"
+type: software

CITATION.cff

@@ -4,50 +4,55 @@
 
 [![Part of OpenStacks](https://img.shields.io/badge/Part%20of-OpenStacks-blue)](https://openstacks.dev)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15250764.svg)](https://doi.org/10.5281/zenodo.15250764)
 
 > Built for use in the field — across health, gender, climate, and education programs in South Asia.
 
 ---
 
 ## What This Is
 
-FieldStack is a collection of **R notebooks, scripts, and sample data** for applied research and evaluation work. It covers survey design, regression analysis, qualitative coding, cost-effectiveness analysis, data visualisation, and reporting — all grounded in real South Asian fieldwork needs.
+FieldStack is a collection of **R notebooks, scripts, and sample data** for applied research and evaluation work. It covers regression analysis, cost-effectiveness, qualitative coding, data visualisation, and reporting — all grounded in real South Asian fieldwork needs.
 
 This is the **applied research layer** of [OpenStacks for Change](https://openstacks.dev) — an open ecosystem of tools for public interest research and evaluation.
 
 ## What's Inside
 
+### Core Scripts
+
+| Directory | What It Does | Status |
+|-----------|-------------|--------|
+| `scripts/` | Index functions: health access, climate vulnerability, education outcomes, MEL reshaping | Ready |
+| `notebooks/` | 4 Quarto notebooks: education summary, public health index, climate risk, MEL dashboard | Ready |
+| `regression/` | Logistic models, interaction terms, multicollinearity checks (VIF) | Ready |
+| `evaluation/` | SROI calculators, cost-effectiveness, qual-to-quant conversion, evaluation summaries | Ready |
+| `custom_viz/` | Waterfall charts, bullet charts, sf map visualisation | Ready |
+| `visualisation/` | ggplot2 dashboard bars, faceted plots | Ready |
+| `qualitative/` | Qualitative coding with quanteda (corpus, tokens, DFM) | Ready |
+
+### Data and Testing
+
+| Directory | What It Contains |
+|-----------|-----------------|
+| `sample_data/` | 4 realistic datasets: climate exposure (150 rows), health services (200), education outcomes (200), MEL indicators (100) |
+| `codebook_templates/` | Variable metadata for health surveys and programme monitoring |
+| `tests/` | 9 testthat unit tests covering all core functions |
+
+### Supporting
+
 | Directory | What It Contains |
 |-----------|-----------------|
-| `notebooks/` | Quarto/R Markdown notebooks for common analysis tasks |
-| `regression/` | Regression templates with interaction terms, multicollinearity checks |
-| `evaluation/` | Cost-effectiveness analysis, SROI calculators, evaluation frameworks |
-| `survey-design/` | Survey sampling, questionnaire design, power calculations |
-| `survey_tools/` | Data reshaping, cleaning, and transformation utilities |
-| `qualitative/` | Qualitative coding examples and mixed-methods templates |
-| `custom_viz/` | Bullet charts, waterfall charts, maps, and custom ggplot themes |
-| `visualisation/` | Standard visualisation templates and chart recipes |
-| `tidyverse/` | Tidyverse-based data wrangling recipes |
-| `simulation/` | Monte Carlo and simulation scripts for evaluation design |
-| `codebook_templates/` | Codebook generation from survey instruments |
-| `automated_reporting/` | Automated report generation workflows |
 | `python_integration/` | R-Python interop via reticulate |
-| `stata/` | Stata companion scripts for cross-platform workflows |
-| `sql/` | SQL queries for database-backed analysis |
-| `tableau/` | Tableau-ready data exports and connection templates |
-| `sample_data/` | Practice datasets for testing (anonymised, realistic) |
-| `scripts/` | Standalone utility scripts |
-| `utils/` | Helper functions and shared utilities |
-| `tests/` | Test scripts for validation |
-| `workflows/` | End-to-end workflow guides |
+| `survey_tools/` | Survey data utilities |
+| `automated_reporting/` | Report generation workflows |
 
 ## Getting Started
 
 ### Prerequisites
 
 - **R 4.0+** with RStudio or VS Code
-- **Key packages:** tidyverse, haven, survey, ggplot2, quarto
-- **Optional:** reticulate (for Python integration), DBI (for SQL)
+- **Key packages:** tidyverse, haven, survey, ggplot2, quarto, testthat
+- **Optional:** reticulate (for Python integration), sf (for mapping)
 
 ### Quick Start
 
@@ -59,6 +64,9 @@ cd FieldStack
 # Open any notebook in RStudio
 # Start with notebooks/ for guided analysis examples
 # Use sample_data/ to test before using your own data
+
+# Run the test suite
+source("tests/run_all_tests.R")
 ```
 
 ### Typical Workflow
@@ -73,32 +81,33 @@ cd FieldStack
 
 FieldStack is one of several stacks in the [OpenStacks](https://openstacks.dev) ecosystem:
 
-| Stack | Focus | Link |
-|-------|-------|------|
-| [InsightStack](https://github.com/Varnasr/InsightStack) | MEL tools, calculators, documentation | Knowledge systems |
-| **FieldStack** (this repo) | R notebooks for fieldwork & evaluation | You are here |
-| [EquityStack](https://github.com/Varnasr/EquityStack) | Python workflows for development data | Data pipelines |
-| [SignalStack](https://github.com/Varnasr/SignalStack) | Research Rundown newsletter archive | Knowledge curation |
+| Stack | Focus |
+|-------|-------|
+| [InsightStack](https://github.com/Varnasr/InsightStack) | MEL tools, calculators, documentation |
+| **FieldStack** (this repo) | R notebooks for fieldwork and evaluation |
+| [EquityStack](https://github.com/Varnasr/EquityStack) | Python workflows for development data |
+| [SignalStack](https://github.com/Varnasr/SignalStack) | Research Rundown newsletter archive |
 
 **Use FieldStack when** you need R-based analysis tools. Use **EquityStack** for Python/Jupyter equivalents. Use **InsightStack** for Stata tools and MEL calculators.
 
 ## Contributing
 
 Contributions welcome — especially from field researchers and evaluators. See [CONTRIBUTING.md](CONTRIBUTING.md).
 
-Useful contributions include:
+High-impact areas:
+- **Survey design** — sample size calculators, PSU allocation, sampling frameworks
+- **Simulation** — Monte Carlo scripts for evaluation design
+- **Visualisation** — heatmaps, treemaps, time series templates
 - R notebooks from your own evaluation work (anonymised)
-- New visualisation recipes for development data
-- Survey design templates and sampling frameworks
-- Bug fixes and documentation improvements
 
 ## Citation
 
 ```bibtex
 @software{fieldstack,
   author = {Sri Raman, Varna},
   title = {FieldStack: R Tools for Applied Development Research},
-  url = {https://github.com/Varnasr/FieldStack}
+  url = {https://github.com/Varnasr/FieldStack},
+  doi = {10.5281/zenodo.15250764}
 }
 ```
 
@@ -108,4 +117,4 @@ MIT — free to use, modify, and share. See [LICENSE](LICENSE).
 
 ---
 
-**Created by [Varna Sri Raman](https://github.com/Varnasr)** — Development Economist & Social Researcher
+Part of [OpenStacks for Change](https://openstacks.dev). Created by [Varna Sri Raman](https://on-web.link/varna).

LICENSE.md

@@ -1,43 +1,37 @@
+# FieldStack Roadmap
 
-# 🛣️ FieldStack Roadmap (2024)
-
-This document outlines planned and in-progress enhancements to ensure FieldStack remains a high-quality, reusable repository for MEL and applied evaluation work.
+Current development priorities and planned work.
 
 ---
 
-## ✅ Completed (as of Apr 2024)
+## Complete
 
-- [x] Fully working R scripts for 5 core sectors (gender, public health, education, climate, MEL)
-- [x] Quarto notebooks with inline charts, data loads, and exports
+- [x] Core R scripts for health access, climate vulnerability, education outcomes, and MEL reshaping
+- [x] 4 Quarto notebooks with data loading, processing, and visualisation
 - [x] Sample data for each module using India-relevant district indicators
-- [x] `testthat` unit tests for all core scripts
+- [x] testthat unit tests for all core scripts
+- [x] Evaluation tools: SROI, cost-effectiveness, qual-to-quant conversion
+- [x] Custom visualisations: waterfall charts, bullet charts, sf maps
+- [x] Qualitative coding example with quanteda
+- [x] Zenodo DOI and citation metadata
 - [x] GitHub Actions for CI and Quarto rendering
-- [x] Citation metadata and usage instructions
-- [x] Project branding and folder map
-
----
 
-## 🧪 In Progress
+## In Progress
 
-- [ ] Add additional `sf`-based spatial mapping examples
-- [ ] Modularise functions with custom R packages (`R/` folder)
-- [ ] Add `.Rmd` versions of all `.qmd` notebooks
+- [ ] Additional sf-based spatial mapping examples
+- [ ] Modularise functions into a custom R package (R/ folder)
 - [ ] Streamlined Shiny dashboard prototype
 
----
+## Planned
 
-## 🔜 Planned Features
-
-- [ ] Expand sample datasets to include real MoSPI/NSS/Census excerpts
-- [ ] Add `contrib/` folder for externally submitted use cases
-- [ ] Translation-ready versions for multilingual training
-- [ ] Zenodo DOI and GitHub Release versioning
-- [ ] Educational visual walkthrough (`.gif` or `.mp4`) for new users
+- [ ] Survey design tools: sample size calculators, PSU allocation, sampling frameworks
+- [ ] Simulation scripts: Monte Carlo for evaluation design, missing data imputation
+- [ ] Expanded visualisation: heatmaps, treemaps, time series templates
+- [ ] Tidyverse pipeline examples for common data wrangling tasks
+- [ ] SQL integration for database-backed analysis
+- [ ] Expanded sample datasets with MoSPI/NSS/Census excerpts
+- [ ] contrib/ folder for externally submitted use cases
 
 ---
 
-## 💬 Feedback & Contributions
-
-You’re welcome to fork, submit pull requests, or suggest improvements via Issues.  
-For structured suggestions, see `CONTRIBUTING.md`.
-
+For suggestions, open an [issue](https://github.com/Varnasr/FieldStack/issues) or start a [discussion](https://github.com/Varnasr/FieldStack/discussions).