RevMan Export

Overview

Generates four types of export from the active review's .revman/ data. Read references/manuscript-assembly.md before assembling manuscripts.

Active review is resolved by the orchestrator. REVIEW_DIR is passed as context.

---

Commands

revman export

Show export menu:

RevMan Export — Active review: {title}

Available exports:
  revman export manuscript      Generate full manuscript (Markdown)
  revman export data            Generate data package (CSV + JSON)
  revman export prisma          Generate PRISMA 2020 checklist
  revman export study-table     Generate study characteristics table
  revman export archive         Generate .tar.gz archive of all data
  revman export all             Run all of the above

revman export manuscript

Assemble a full systematic review manuscript from sections.

Procedure:

1. Determine the manuscript directory: {REVIEW_DIR}/manuscripts/. Create if missing.

2. Read the review metadata from review.json.

3. Check for existing section files in .revman/writing/:

   | Section | File | If missing | |---------|------|------------| | Title/ Authors | — | From review.json | | Abstract | abstract.md | Generated placeholder | | Introduction | introduction.md | Generated from PICO | | Methods | methods.md | Generated from protocol + phase outputs | | Results | results.md | Generated from screening + studies + analyses | | Discussion | discussion.md | Placeholder | | Conclusions | conclusions.md | Placeholder |

4. Assemble the manuscript in this order:

   # {Title}
   
   {Authors}
   
   ## Abstract
   {abstract}
   
   ## Introduction
   {introduction}
   
   ## Methods
   {methods}
   
   ## Results
   
   ### Study Selection
   ![PRISMA 2020 Flow Diagram](../PRISMA_2020_flow.png)
   
   ### Study Characteristics
   {study_characteristics_table}
   
   ### Risk of Bias
   {rob_summary}
   
   ### Synthesis Results
   ![Forest Plot](../forest_plot.png)
   ![Funnel Plot](../funnel_plot.png)
   
   ### Certainty of Evidence
   {sof_table}
   
   ## Discussion
   {discussion}
   
   ## Conclusions
   {conclusions}
   
   ## References
   {references}
   

5. Insert images with relative paths (generated by revman-forest, revman-funnel, revman-prisma).

6. Generate study characteristics table (run revman export study-table inline).

7. Generate SoF table from .revman/grade/sof.json if it exists.

8. Write to {REVIEW_DIR}/manuscripts/manuscript.md.

9. Confirm:

   Manuscript saved to reviews/{name}/manuscripts/manuscript.md
   Sections: {N}  |  Images referenced: {M}
   

Important: Do NOT fabricate content. If a section file doesn't exist, write a placeholder:

<!-- Introduction — not yet written. Use revman write to draft this section. -->

revman export data

Generate structured data package (CSV + JSON).

Procedure:

1. Run:

   echo '{"mode":"data-package","params":{"review_dir":"{REVIEW_DIR}"}}' | python3 scripts/revman-export.py
   

2. Report what was generated:

   Data package saved to {REVIEW_DIR}/.revman/export/data-package/
     studies.csv        — {N} studies
     arms.csv           — {N} arms
     outcomes.csv       — {N} outcome entries
     risk_of_bias.csv   — {N} assessments    (if RoB data exists)
     summary_of_findings.json  — SoF table  (if GRADE data exists)
     review.json        — Review metadata
   

revman export prisma

Generate PRISMA 2020 compliance checklist.

The checklist has 27 items across TITLE, ABSTRACT, INTRODUCTION, METHODS, RESULTS, DISCUSSION, and OTHER sections.

Procedure:

1. Run:

   echo '{"mode":"prisma-checklist","params":{"review_dir":"{REVIEW_DIR}"}}' | python3 scripts/revman-export.py
   

2. Each item is auto-populated with status based on phase completion:
   • ✅ completed = phase is done
   • 🔄 in_progress = phase is active
   • ⬜ not_started = phase not yet reached
3. Output: {REVIEW_DIR}/.revman/export/prisma_2020_checklist.md
4. Confirm:

   PRISMA 2020 checklist saved.
   Items completed: {N}/27
   

revman export study-table

Generate a study characteristics table in Markdown.

Procedure:

1. Run:

   echo '{"mode":"study-table","params":{"review_dir":"{REVIEW_DIR}"}}' | python3 scripts/revman-export.py
   

2. Output: {REVIEW_DIR}/.revman/export/study_characteristics.md
3. Confirm:

   Study characteristics table saved. {N} studies.
   

revman export archive

Package the entire review into a .tar.gz archive.

Procedure:

1. Run:

   echo '{"mode":"archive","params":{"review_dir":"{REVIEW_DIR}"}}' | python3 scripts/revman-export.py
   

2. Includes:
   • .revman/ directory (all data)
   • Generated images (forest, funnel, PRISMA)
   • Manuscript files
3. Output: {REVIEW_DIR}/.revman/export/{name}-archive.tar.gz
4. Confirm:

   Archive saved. {size} MB
   

revman export all

Run all exports in sequence: manuscript → data → prisma → study-table → archive.

Procedure:

1. Run each export in order.
2. Report a summary of all outputs.

---

Error Handling

| Situation | Response | |-----------|----------| | No active review | "No active review. Use revman new or revman open first." | | No studies | "No study data found. Use revman studio to add studies before exporting." | | No manuscript sections | "No manuscript sections found. Use revman write to draft sections." | | Python script error | "Export script error: {detail}" | | Missing images | "Warning: {image} not found. Will reference path but image may be missing from manuscript." |