Practical Session: Report Generator

Custom Reports Template Builder 60 minutes
Practical Session Objectives:
By the end of this hands-on session, participants will be able to:
  • Navigate the RevProHub Reports Dashboard and understand report lifecycle
  • Create new reports using pre-defined or custom templates
  • Build custom report templates using JSON structure (PRISMA, study lists, exclusion tables)
  • Generate reports with auto-populated sections (PRISMA diagram, QA charts, data extraction)
  • Export reports as DOCX or PDF for manuscript submission
  • Add report sections directly to the Manuscript Editor
  • Regenerate and manage existing reports

Part 1: Reports Dashboard

Navigate to: Reporting Phase → Report Generator → Project Reports


Existing Reports
View, regenerate, delete

New Report
Create from templates

Manage Templates
Create/edit JSON templates
📋 Report Actions: View, Regenerate (refresh data), Delete. Reports are generated once and can be regenerated when underlying data changes.

Part 2: Creating a New Report

Navigate to: Reports Dashboard → New Report

1 Enter Report Title – e.g., "Final Systematic Review Report - GLP-1 Agonists"
2 Select a Template – Choose from pre-existing templates (PRISMA diagram, study characteristics, exclusion reasons, data extraction summary, QA charts, etc.)
3 Click "Create and Generate" – System compiles real-time project data into the report

Available Pre-Defined Templates:

PRISMA 2020 Flow Diagram
Automatic flow diagram from screening data
Characteristics of Included Studies
Table of study metadata (title, authors, year, journal, DOI)
Excluded Studies with Reasons
Full-text exclusions with exclusion reasons
Quality Assessment Chart
Risk of bias visualization
Data Extraction Summary
Extracted data per study
Synthesized Data Charting
Meta-analysis results and forest plots

Part 3: Template Builder – Creating Custom Report Templates

Navigate to: Reports Dashboard → Manage Templates → Create New Template

Templates are JSON-based structures defining report sections. Each section has a type (e.g., prisma_flow_diagram, study_list, full_text_exclusion_reasons_table) and customizable title.

Template Snippet Library

Basic PRISMA Report 
{
  "sections": [
    {
      "title": "PRISMA 2020 Flow Diagram",
      "type": "prisma_flow_diagram"
    },
    {
      "title": "Characteristics of Included Studies",
      "type": "study_list",
      "columns": ["title","authors","year","journal","doi"]
    }
  ]
}
Full Report with Exclusions 
{
  "sections": [
    {"title":"PRISMA 2020 Flow Diagram","type":"prisma_flow_diagram"},
    {"title":"Studies Excluded at Full-Text Stage","type":"full_text_exclusion_reasons_table"},
    {"title":"QA Diagram","type":"quality_assessment_chart"},
    {"title":"Characteristics of Included Studies","type":"study_list"}
  ]
}
Complete Standard Report 
{
  "sections": [
    {"title":"PRISMA 2020 Flow Diagram","type":"prisma_flow_diagram"},
    {"title":"QA Diagram","type":"quality_assessment_chart"},
    {"title":"Studies Excluded at Full-Text Stage","type":"full_text_exclusion_reasons_table"},
    {"title":"Characteristics of Included Studies","type":"study_list","columns":["title","authors","year","type","journal","doi"]},
    {"title":"Data Extraction Summary","type":"data_extraction_summary"},
    {"title":"Data Extraction Charting","type":"data_extraction_chart"}
  ]
}
📚 Available Section Types:
  • prisma_flow_diagram – Auto-generated from screening data
  • study_list – Table of included studies (requires columns array)
  • full_text_exclusion_reasons_table – Excluded studies with reasons
  • quality_assessment_chart – Risk of bias visualization (from QA module)
  • data_extraction_summary – Extracted data per study (from consensus data)
  • data_extraction_chart – Generic table builder for extracted data

Part 4: Report Output Example

Generated Report Sections (example):
  • PRISMA 2020 Flow Diagram: Interactive SVG with copy/download options
  • Studies Excluded at Full-Text Stage: Two-column table (Title + Exclusion Reasons)
  • Characteristics of Included Studies: Multi-column table with study metadata
  • QA Diagram: Risk of bias chart (if QA data available)
  • Data Extraction Summary: Extracted data per included study
TitleAuthorsYearJournalDOI
Effectiveness of Semaglutide for Weight ManagementWilding JPH et al.2021NEJM10.1056/NEJMoa2032183
Liraglutide and Cardiovascular Outcomes in T2DMarso SP et al.2016The Lancet10.1016/S0140-6736(16)30517-2
Tirzepatide versus Semaglutide for ObesityJastreboff AM et al.2022NEJM10.1056/NEJMoa2206038

Part 5: Export & Integration

Export as DOCX
Editable Word document for manuscript submission
Export as PDF
Print-ready format for stakeholders
Add to Manuscript
Inject sections into Manuscript Editor
✏️ Adding to Manuscript: Each report section has an "Add to Manuscript" button. Clicking it stages the content (table, diagram, or text) for insertion into the Manuscript Editor. Select which manuscript to add to.

Part 6: Managing Templates

✏️ Edit Template: Modify existing JSON structures – update section titles, add/remove columns, change section order
🗑️ Delete Template: Remove custom templates (system templates are protected)
🔄 Regenerate Report: After data updates (new studies, changed screening decisions, new extraction data), regenerate to refresh all sections
🧪 Group Hands-On Activity: Report Generator (45 min)
  1. Access Reports Dashboard: Reporting Phase → Report Generator → Project Reports.
  2. Review Existing Reports: Note the list of previously generated reports. Observe status (Complete) and available actions (View, Regenerate, Delete).
  3. Create a New Report: Click "New Report". Title it "Training Report – PRISMA + Study Characteristics".
  4. Select Template: Choose "Characteristics of Included Studies" template. Click "Create and Generate".
  5. View Generated Report: Review the PRISMA flow diagram (auto-populated from screening data) and the study characteristics table.
  6. Export as DOCX: Click Export → DOCX. Download and open to verify table formatting.
  7. Create Custom Template (Advanced): Go to Manage Templates → Create New Template. Name: "Advanced Report Template".
  8. Build JSON Structure: Copy the "Complete Standard Report" snippet from the library. Paste into Content Structure editor. Save.
  9. Generate Report from Custom Template: Create new report → select "Advanced Report Template" → generate.
  10. Add Section to Manuscript: In the generated report, locate the "Characteristics of Included Studies" section. Click "Add to Manuscript". Select your manuscript from dropdown. Confirm.
  11. Regenerate Report: Make a change in screening (e.g., exclude a study). Return to reports → click "Regenerate" on your report. Verify the excluded study no longer appears in the included studies table.

Debrief Questions:

  • What is the advantage of JSON-based template building over fixed report formats?
  • How does the "Regenerate" feature ensure report accuracy as the review progresses?
  • When would you use the "Add to Manuscript" button vs. exporting as DOCX and copying manually?
  • What section types would you include in a final Cochrane-style systematic review report?
  • How does the PRISMA flow diagram auto-populate from screening data ensure reproducibility?

Best Practices for Report Generation

Recommendations:
  • Generate a "baseline" report after completing screening but before extraction – serves as a progress snapshot
  • Create custom templates for different audiences (technical report for researchers, summary report for policymakers)
  • Use the "Add to Manuscript" feature for seamless integration – avoids copy-paste errors
  • Regenerate reports after major data updates (e.g., after conflict resolution, after extraction completion)
  • Export final reports as PDF for submission to journals or stakeholders
  • Keep template JSON files version-controlled for auditability

Integration with Review Workflow

From Data to Report:
  • 1️⃣ Screening → PRISMA flow diagram, excluded studies list
  • 2️⃣ Quality Assessment → Risk of bias charts
  • 3️⃣ Data Extraction → Extracted data tables, outcome summaries
  • 4️⃣ Data Synthesis → Meta-analysis results, forest plots
  • 5️⃣ Report Generator → Compiles all into customizable report
  • 6️⃣ Manuscript Editor → Sections added for final publication
Report Generator Completion Checklist:
✔ Report created using pre-defined template
✔ PRISMA flow diagram verified against screening data
✔ Study characteristics table reviewed for completeness
✔ Excluded studies table verified with reasons
✔ Custom JSON template created and tested
✔ Report exported as DOCX and PDF
✔ Report sections added to Manuscript Editor
✔ Report regenerated after data update
✔ Final report ready for stakeholder sharing

Next: Manuscript Editor – finalizing publication-ready systematic review manuscripts.

2026 RevProHub Training – Ethiopia Ministry of Health & ESEP
Practical Session: Report Generator | Custom Templates | PRISMA Diagram | Export DOCX/PDF | Manuscript Integration