WFP Jordan Data Quality Automation

Comprehensive documentation for the Data Quality and Overview Application

Welcome! πŸ‘‹

This documentation site provides everything you need to work with the WFP Data Quality and Overview Application for Jordan. Whether you’re adding new exercises, exploring survey data, or understanding the system architecture, you’ll find comprehensive guides and examples here.

πŸš€ Quick Navigation

Quick Start Guide

Add a new exercise in ~20 minutes with ready-to-use templates and copy-paste code.

Best for: Moving quickly, following a proven recipe

Interactive Discovery

Learn how to find and explore surveys using the interactive discovery tools.

Best for: Understanding the discovery process, hands-on learning

Adding New Exercises

Complete reference guide covering all aspects of exercise creation, validation, and visualization.

Best for: Comprehensive information, troubleshooting, advanced topics

BCM Welcome Meals Example

Real-world walkthrough of implementing a complete exercise from start to finish.

Best for: Learning by example, seeing actual implementation decisions

🎯 Choose Your Path

I want to add an exercise quickly

β†’ Start with Quick Start Guide

  1. Run tools/discover_surveys.r to find your survey
  2. Copy the template
  3. Fill in details
  4. Test in app

Time: ~20 minutes

I want to learn the discovery process

β†’ Read Interactive Discovery Guide

  1. Understand survey discovery
  2. Learn exploration techniques
  3. Follow step-by-step tutorial

Time: ~30 minutes

I need complete reference information

β†’ See Adding New Exercises

  • Complete exercise structure
  • All validation rules
  • All UI components
  • Troubleshooting guide

Time: Reference as needed

I want to see a real example

β†’ Study BCM Welcome Meals Example

  • See actual implementation
  • Understand decisions made
  • Learn patterns

Time: ~15 minutes

πŸ—οΈ Application Architecture

The application uses a registry-based system where exercises are automatically discovered and loaded from the app/exercises/ directory.

Architecture Flow:

Main App (app.r)
    ↓
Exercise Registry (exercise_registry.r)
    ↓
    β”œβ”€β”€ Exercise 1
    β”œβ”€β”€ Exercise 2
    └── Exercise N
        ↓
    Reusable Components
        β”œβ”€β”€ Validation Rules
        β”œβ”€β”€ UI Components
        └── Helper Functions

Core Components

Exercise Files (app/exercises/*.r)

Each exercise is self-contained with metadata, data fetching, validation rules, and visualizations.

Validation Rules (app/R/validation_rules.r)

Reusable validation functions including duration checks, submission validations, and data quality rules.

Visualization Helpers (app/R/visualization_helpers.r)

Pre-built UI components for metrics, breakdowns, and dashboards.

πŸ” Key Features

1. Automatic Exercise Discovery

  • Place file in app/exercises/
  • App automatically detects and loads it
  • No manual registration needed

2. Interactive Survey Discovery

3. Reusable Components

  • Pre-built validation rules
  • Consistent UI patterns
  • Easy to extend

4. Real-time Validation

  • Multiple validation rules per exercise
  • Clear pass/fail indicators
  • Detailed error information

5. Custom Dashboards

  • Exercise-specific visualizations
  • Monitoring metrics
  • Responsive layouts

πŸ“š Documentation Sections

User Guides

Comprehensive guides for adding exercises, working with metadata, and understanding validation coverage.

Examples

Real-world examples showing complete implementations:

Development Notes

Internal development documentation for understanding implementation decisions and architecture changes.

πŸŽ“ Learning Path

  1. Read this overview page
  2. Run the app: shiny::runApp("app")
  3. Try discovery tool: source("tools/discover_surveys.r")
  4. Study Quick Start Guide
  1. Review Interactive Discovery Guide
  2. Study existing exercises in app/exercises/
  3. Read validation rules in app/R/validation_rules.r
  4. Create your first exercise using the template
  1. Read complete Adding New Exercises
  2. Study the registry system: app/R/exercise_registry.r
  3. Create custom validation rules
  4. Build custom visualization components
  5. Extend the framework

πŸ“ Quick Reference

I want to… Go to…
Add an exercise quickly Quick Start
Learn survey discovery Interactive Discovery
Get complete reference Adding New Exercises
See a real example BCM Welcome Meals
Understand validation coverage Validation Coverage
Work with metadata Adding Metadata
Troubleshoot issues Troubleshooting Guide
WarningGetting Started

Before you begin, ensure you have:

  • R and RStudio installed
  • Access to DataBridges API credentials
  • The project repository cloned locally

See the Quick Start Guide for setup instructions.

Ready to get started? Choose your path above and dive in! πŸš€

Back to top