Data Quality Check

Overview

This is a Shiny application package for high frequency check for food security surveys data quality and visualization of the trend on the key food security indicators. This app serves for enumerator performance checking and flagging issue. This is a support and joint effort from WACARO RAM Team.

Features

• Upload data in SPSS format (local format) or directly from MoDa datasets up to 500MB
• Analyze food security indicators:
  • Food Consumption Score (FCS)
  • Household Dietary Diversity Score (HDDS)
  • Reduced Coping Strategy Index (rCSI)
  • Household Hunger Scale (HHS)
  • FewsNet Matrix Table
  • Livelihood Coping Strategy Index (LCS)
  • Food Expenditure Share (FES)
  • Consolidated Approach for Reporting Indicators of Food Security (CARI)
• View results by administrative levels (Admin1, Admin2) and by enumerator
• Track survey progress with submission vs planned
• Generate comprehensive HTML reports with visualizations

Installation

Prerequisites

• R Version: R >= 4.4.3 (as specified in DESCRIPTION)
• System Requirements: Sufficient RAM to handle datasets up to 500MB
• Internet Connection: Required for MoDa API integration and package installation

Installation Steps

1. Install R and RStudio (if not already installed):

   • Download R from CRAN
   • Download RStudio from Posit

2. Clone the repository:

   git clone https://github.com/WFP-VAM/wfp-data-quality-app.git
   cd wfp-data-quality-app

3. Launch RStudio from the project directory:

   # Open RStudio from the current directory
   open wfp-data-quality-app.Rproj    # On macOS
   # OR
   rstudio wfp-data-quality-app.Rproj  # On Linux/Windows
   # OR simply double-click the .Rproj file in your file manager

4. Install renv and restore packages (in RStudio):

   install.packages("renv")
   renv::restore()  # Installs exact package versions from renv.lock

5. Install the app as a package:

   devtools::install(".", dependencies = FALSE)  # renv already installed deps

6. Launch the application:

   wfp.data.quality.app::run_app()

Package Management

This project uses renv for reproducible package management:

• renv.lock contains exact versions of all dependencies
• renv::restore() installs the same package versions used in development
• Key dependencies include:
  • Core Shiny: shiny, shinydashboard
  • Data Processing: dplyr, tidyverse, haven, labelled
  • Visualization: ggplot2, plotly, treemapify
  • Statistical Analysis: rstatix
  • Data Export: writexl, openxlsx, DT, kableExtra
  • API Integration: httr, jsonlite

Development Mode

For developers who want to modify the package:

# Load the package in development mode (without installing)
devtools::load_all(".")

# Or use R CMD for traditional installation
R CMD INSTALL .

Docker Deployment

For containerized deployment with reproducible dependencies:

docker build -t wfp-data-quality-app .
docker run -d -p 3838:3838 wfp-data-quality-app

See DEPLOYMENT.md for detailed Docker instructions.

Requirements

The application requires datasets with standard variable names from survey designer.

Contact

For questions or support, please contact:

• Aliou Badara SAMAKE: [email protected] or [email protected]