User Guide - dlangkip/epidash GitHub Wiki

User Guide

This guide explains how to use the EpiDash dashboard effectively to explore and analyze epidemiological data.

Dashboard Overview

Dashboard Layout

Note: You'll need to upload this and other images directly to your wiki for proper display.

The EpiDash interface consists of several key sections:

  1. Header Bar: Contains the logo, navigation menu, data source selector, and user menu
  2. Sidebar: Houses filters and quick statistics
  3. Metrics Cards: Displays key statistical indicators
  4. Visualization Area: Contains various charts and maps for data visualization
  5. Data Table: Shows detailed tabular data with pagination and export options

Navigation and Controls

Data Source Selection

In the header bar, you can select between different data sources:

  • Mock Data: Uses synthetic data generated based on realistic patterns (default)
  • Database: Uses actual data from the connected database (if configured)
  • Both Sources: Combines data from both sources

Note: Add a screenshot of the data source selector to your wiki

Date Range Selection

At the top of the main content area, you can set a custom date range:

  1. Set the start date in the "From" field
  2. Set the end date in the "To" field
  3. Click the "Update" button to apply the date range

The dashboard will refresh to show data only within the selected date range.

Using Filters

The sidebar contains various filters to refine the displayed data:

Disease Filter

Select a specific disease from the dropdown menu, or choose "All Diseases" to view combined data across all diseases.

Region Filter

Select a specific geographic region (county) from the dropdown menu, or choose "All Regions" to view data across all regions.

Age Group Filter

Check or uncheck boxes to include or exclude specific age groups:

  • 0-14 years
  • 15-24 years
  • 25-44 years
  • 45-64 years
  • 65+ years

Gender Filter

Select from the following options:

  • All (default)
  • Male
  • Female

Data Grouping

Choose how to aggregate data over time:

  • Daily: Show individual daily data points
  • Weekly: Group data by week (default)
  • Monthly: Group data by month
  • Quarterly: Group data by quarter
  • Yearly: Group data by year

Applying Filters

After setting your desired filters:

  1. Click the "Apply Filters" button to update all visualizations and data displays
  2. Use the "Reset Filters" button to return to default filter settings

Understanding Visualizations

EpiDash provides multiple visualizations to help analyze epidemiological data:

Key Metrics Cards

The metrics cards at the top of the dashboard provide at-a-glance statistics:

  • Total Cases: The sum of all cases meeting the current filter criteria
  • Active Cases: Cases that are currently active (not recovered or deceased)
  • Recovery Rate: Percentage of total cases that have recovered
  • Mortality Rate: Percentage of total cases that resulted in death

Disease Trends Chart

This line chart shows the progression of disease cases over time:

  • X-axis represents time based on the selected grouping (daily, weekly, etc.)
  • Y-axis shows the number of cases
  • Multiple lines appear when viewing all diseases, with each line representing a different disease
  • Hover over data points to see specific values

Regional Distribution Chart

This bar chart shows the distribution of cases across regions:

  • X-axis shows regions (counties)
  • Y-axis shows the number of cases
  • Displays the top regions by case count
  • Hover over bars to see specific values

Geographic Prevalence Map

This choropleth map visualizes disease prevalence across geographic regions:

  • Regions are color-coded based on case counts (darker colors indicate higher case counts)
  • Hover over a region to see its name and case count
  • Click on a region to zoom in for a closer view
  • Use the map controls to zoom in/out and pan

Age Distribution Chart

This pie chart shows the distribution of cases across age groups:

  • Each slice represents an age group
  • The size of each slice indicates the proportion of cases in that age group
  • Hover over slices to see specific values and percentages

Recovery Timeline Chart

This line chart compares cases and recoveries over time:

  • X-axis represents time based on the selected grouping
  • Y-axis shows counts of cases and recoveries
  • Two lines allow for comparison between new cases and recovery trends
  • Hover over data points to see specific values

Working with Tabular Data

The data table at the bottom of the dashboard provides a detailed view of the filtered data:

Searching the Table

Use the search box above the table to filter the displayed rows. The search will match any text in the table, including region names, disease names, and dates.

Sorting Table Data

Click on column headers to sort the table by that column. Click again to toggle between ascending and descending order.

Pagination

Navigate through multiple pages of data using the pagination controls below the table:

  • Use "Previous" and "Next" buttons to move between pages
  • The page indicator shows your current position (e.g., "Page 2 of 5")

Exporting Data

Click the "Export CSV" button to download the currently filtered data as a CSV file. This file can be opened in spreadsheet applications like Microsoft Excel or Google Sheets for further analysis.

Quick Statistics

The sidebar displays quick statistics based on the current filter settings:

  • Highest Incidence: Disease with the most cases in the filtered data
  • Most Affected Region: Region with the highest case count
  • Least Affected Region: Region with the lowest case count
  • Trend Direction: Whether cases are increasing, decreasing, or stable over the selected time period

Tips for Effective Analysis

Comparing Disease Patterns

To compare multiple diseases:

  1. Select "All Diseases" in the disease filter
  2. Apply other filters as needed (region, date range, etc.)
  3. Observe the disease trends chart to see how different diseases compare over time

Identifying Seasonal Patterns

To identify seasonal trends:

  1. Set a date range covering at least one year
  2. Select "Monthly" or "Quarterly" grouping
  3. Observe the disease trends chart to identify recurring patterns

Regional Analysis

To compare different regions:

  1. Select a specific disease of interest
  2. Use "All Regions" in the region filter
  3. Examine both the regional distribution chart and the geographic map
  4. Look for clusters or patterns in specific geographic areas

Demographic Analysis

To understand demographic impacts:

  1. Apply filters for specific demographics (age groups, gender)
  2. Compare results with different demographic selections
  3. Note which groups show higher incidence for specific diseases

Data Export for Advanced Analysis

For more complex analyses:

  1. Set filters to isolate data of interest
  2. Export the filtered data using the "Export CSV" button
  3. Use external tools (Excel, R, Python) for statistical analysis
  4. Import findings back into presentations or reports

Troubleshooting

Data Not Loading

If visualizations or data don't load:

  1. Check your internet connection
  2. Verify that the selected data source is available
  3. Try refreshing the page
  4. Check for any error messages in the browser console (F12 on most browsers)

Filters Not Working

If filters don't seem to apply correctly:

  1. Ensure you've clicked the "Apply Filters" button after making changes
  2. Try resetting filters to default using the "Reset Filters" button
  3. Verify that the combination of filters isn't too restrictive (resulting in no data)

Performance Issues

If the dashboard seems slow:

  1. Try reducing the date range to analyze a smaller dataset
  2. Use a more aggregated time grouping (monthly instead of daily)
  3. Apply more specific filters to reduce the amount of data being processed
  4. Ensure your browser is up to date

For any additional questions or issues, please refer to the Technical Documentation or contact the developer directly.