Skip to content

Commit 856b228

Browse files
VarnasrVarnasr
committed
Misc
1 parent aa0161a commit 856b228

3 files changed

Lines changed: 79 additions & 83 deletions

File tree

‎README.md‎

Lines changed: 66 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,51 @@
1-
<!-- Banner placeholder -->
2-
<!-- ![FieldStack banner](banner/FieldStack_banner.png) -->
3-
> _(Banner not displaying? Ensure `banner/FieldStack_banner.png` is pushed to the correct folder with exact name & case.)_
1+
![FieldStack banner](https://raw.githubusercontent.com/Varnasr/FieldStack/main/banner/FieldStack_banner.png)
42

53
<!-- TOC START -->
64
## 📚 Table of Contents
75

8-
- [What’s Inside](#-whats-inside)
9-
- [How to Use](#-how-to-use)
10-
- [Cite This](#-cite-this)
6+
- [👋 Welcome](#👋-welcome)
7+
- [🧠 Why FieldStack](#🧠-why-fieldstack)
8+
- [🧪 How to Use](#🧪-how-to-use)
9+
- [🧰 Featured Modules](#🧰-featured-modules)
10+
- [📁 Folder Map](#📁-folder-map)
11+
- [📦 Included Modules (2025)](#📦-included-modules-(2025))
12+
- [🔗 Related](#🔗-related)
13+
- [📊 Repository Status & Metadata](#📊-repository-status-&-metadata)
14+
- [📜 License](#📜-license)
15+
- [📑 Cite This](#📑-cite-this)
16+
- [✉️ Contact](#✉️-contact)
1117

18+
<!-- TOC END -->
19+
20+
## 👋 Welcome
21+
22+
**FieldStack** is a personal, open-source collection of reusable R code, Quarto notebooks, and sample datasets that I’ve developed over years of working in public health, gender equity, education, climate resilience, and MEL.
23+
24+
It’s meant for:
25+
- Researchers and MEL professionals needing clean, modular R logic
26+
- Students looking for working examples tied to real development problems
27+
- Field practitioners building quick summaries, dashboards, or insights
28+
29+
Every script and notebook runs out of the box using included data.
30+
Everything is tested, documented, and designed to reflect **real South Asian fieldwork needs**.
31+
32+
---
33+
34+
35+
## 🧪 How to Use
36+
37+
- 🔁 Clone the repo or download ZIP
38+
- 📊 Open any `.qmd` in RStudio to explore summaries
39+
- 🧪 To run all tests:
40+
```r
41+
source("tests/run_all_tests.R")
42+
```
43+
44+
To export dashboard-ready CSVs, use the MEL module or edit any notebook’s output block.
1245

1346
---
1447

48+
1549
## 🧰 Featured Modules
1650

1751
Explore working, documented code across:
@@ -41,20 +75,21 @@ CI workflows enabled — badge will display after first successful run
4175

4276
---
4377

44-
## 👋 Welcome
4578

46-
**FieldStack** is a personal, open-source collection of reusable R code, Quarto notebooks, and sample datasets that I’ve developed over years of working in public health, gender equity, education, climate resilience, and MEL.
47-
48-
It’s meant for:
49-
- Researchers and MEL professionals needing clean, modular R logic
50-
- Students looking for working examples tied to real development problems
51-
- Field practitioners building quick summaries, dashboards, or insights
79+
## 📁 Folder Map
5280

53-
Every script and notebook runs out of the box using included data.
54-
Everything is tested, documented, and designed to reflect **real South Asian fieldwork needs**.
81+
```
82+
FieldStack/
83+
├── scripts/ # Core reusable R functions
84+
├── notebooks/ # Quarto notebooks (runnable)
85+
├── tests/ # Unit tests
86+
├── sample_data/ # Example CSVs for each use case
87+
├── banner/ # Banner image
88+
```
5589

5690
---
5791

92+
5893
## 📦 Included Modules (2025)
5994

6095
Each module includes:
@@ -73,32 +108,31 @@ Each module includes:
73108

74109
---
75110

76-
## 🧪 How to Use
77111

78-
- 🔁 Clone the repo or download ZIP
79-
- 📊 Open any `.qmd` in RStudio to explore summaries
80-
- 🧪 To run all tests:
81-
```r
82-
source("tests/run_all_tests.R")
83-
```
112+
## 🔗 Related
84113

85-
To export dashboard-ready CSVs, use the MEL module or edit any notebook’s output block.
114+
🌐 Also see:
115+
**EquityStack** → Python + Jupyter + Notebooks for social data
116+
🔗 [github.com/Varnasr/EquityStack](https://github.com/Varnasr/EquityStack)
86117

87118
---
88119

89-
## 📁 Folder Map
90120

91-
```
92-
FieldStack/
93-
├── scripts/ # Core reusable R functions
94-
├── notebooks/ # Quarto notebooks (runnable)
95-
├── tests/ # Unit tests
96-
├── sample_data/ # Example CSVs for each use case
97-
├── banner/ # Banner image
98-
```
121+
## 📊 Repository Status & Metadata
122+
123+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue?label=license)](LICENSE)
124+
[![Maintained](https://img.shields.io/badge/maintained-yes-brightgreen?label=2025)]()
99125

100126
---
101127

128+
129+
## 📜 License
130+
131+
MIT License — feel free to fork, reuse, or build on this work.
132+
133+
---
134+
135+
102136
## 📑 Cite This
103137

104138
> Sri Raman, V. (2025). *FieldStack: Reproducible R Code for MEL, Evaluation, and Social Data*. Zenodo. https://doi.org/10.5281/zenodo.15250764
@@ -118,26 +152,6 @@ FieldStack/
118152

119153
---
120154

121-
## 📊 Repository Status & Metadata
122-
123-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue?label=license)](LICENSE)
124-
[![Maintained](https://img.shields.io/badge/maintained-yes-brightgreen?label=2025)]()
125-
126-
---
127-
128-
## 🔗 Related
129-
130-
🌐 Also see:
131-
**EquityStack** → Python + Jupyter + Notebooks for social data
132-
🔗 [github.com/Varnasr/EquityStack](https://github.com/Varnasr/EquityStack)
133-
134-
---
135-
136-
## 📜 License
137-
138-
MIT License — feel free to fork, reuse, or build on this work.
139-
140-
---
141155

142156
## ✉️ Contact
143157

@@ -148,16 +162,4 @@ MIT License — feel free to fork, reuse, or build on this work.
148162

149163
---
150164

151-
## 🧠 Why FieldStack?
152-
153-
This repository reflects my approach to building transparent, reusable, and field-adapted tools for the social sector — especially in the Indian and South Asian context.
154-
155-
I believe good evaluation tools should be:
156-
- Easy to adapt 🧩
157-
- Easy to test 🔍
158-
- Easy to learn from 📚
159-
160-
You're welcome to explore, borrow, cite, fork — or reach out with your own use cases.
161165

162-
Thanks for visiting ✨
163-
– Varna

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<body>
4848

4949
<header>
50-
<img src="banner/FieldStack_banner.png" alt="FieldStack banner" style="max-width: 100%; height: auto;" />
50+
<img src="https://raw.githubusercontent.com/Varnasr/FieldStack/main/banner/FieldStack_banner.png" alt="FieldStack banner" style="max-width: 100%; height: auto;" />
5151
<h1>Welcome to FieldStack</h1>
5252
<p>Reusable R tools and workflows for MEL, evaluation, and social research in South Asia.</p>
5353
</header>

‎workflows/r-tests.yml‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,20 @@
1-
2-
name: Run R Tests
1+
name: R-CMD-check
32

43
on:
54
push:
6-
branches: [ main ]
5+
branches: [main]
76
pull_request:
8-
branches: [ main ]
7+
branches: [main]
98

109
jobs:
11-
test:
10+
R-CMD-check:
1211
runs-on: ubuntu-latest
13-
1412
steps:
15-
- uses: actions/checkout@v3
16-
17-
- name: Set up R
18-
uses: r-lib/actions/setup-r@v2
19-
20-
- name: Install testthat
21-
run: |
22-
R -e 'install.packages("testthat", repos="https://cloud.r-project.org")'
23-
24-
- name: Run tests
25-
run: |
26-
R -e 'testthat::test_dir("tests", reporter = "summary")'
13+
- uses: actions/checkout@v3
14+
- uses: r-lib/actions/setup-r@v2
15+
- name: Install dependencies
16+
run: |
17+
Rscript -e 'install.packages(c("testthat", "dplyr", "ggplot2", "sf", "car", "tibble", "quanteda", "reticulate"))'
18+
- name: Run tests
19+
run: |
20+
Rscript tests/run_all_tests.R

0 commit comments

Comments
 (0)