Every Rayyan export is a ZIP file with two files inside: the articles file, with your references and the data your team added, and the customizations_log file, a record of every action in the review. Both files come with every export, whatever stage you export from.
The articles file
The articles file contains your references, with the main details from the original source file. The extra columns depend on the stage you exported from.
Screening and Full text screening exports
All the Rayyan data appears in the notes column, separated by pipes ( | ). If a reference already had notes when it was imported, those are kept, and Rayyan's data is added after them.
RAYYAN-INCLUSION: {"USER1"=>"Excluded", "USER2"=>"Included"} | RAYYAN-LABELS: RCT,Data Extraction | RAYYAN-EXCLUSION-REASONS: wrong population | USER-NOTES: {"USER1"=>["note text"]}| Prefix | What it contains |
|---|---|
| RAYYAN-INCLUSION | Each member's decision on the reference (Included, Excluded, or Maybe) |
| RAYYAN-LABELS | Labels applied to the reference, separated by commas |
| RAYYAN-EXCLUSION-REASONS | Exclusion reasons applied. Only appears when at least one member added a reason |
| USER-NOTES | Notes added by each member |
Data Extraction exports
Data Extraction exports add two kinds of columns:
- PDF files: the name of the PDF attached to the article, if any.
- Question columns: one column per extraction question, named with a number and the column title, such as 671-STUDY DESIGN. Each row shows the answer for that article.
Risk of Bias exports
Risk of Bias exports follow the same pattern, with columns for each tool, named with a number and the tool name, such as 275902-RoB 2 (randomized trials). Each cell shows the overall judgment for that article, such as low, moderate, or high, without reviewer names. When reviewers reach different judgments, each one appears on its own line in the same cell. Each reviewer's answers to the individual questions are in the customizations_log, in JSON format.
Open these files with UTF-8 encoding, so special characters display correctly.
The customizations_log file
The customizations_log is a full record of every action in the review. Use it to track a decision change, check a team member's work, or see when something happened. Each row is one action, with six columns: created_at (date and time), user_id, user_email, article_id, key (what changed), and value (what happened).
How to read the log
- The key included means a decision was recorded, not that the article was included. The value shows which decision.
- Every change is recorded in order, so a member who changed their decision several times appears several times for the same article.
- When a member excludes an article with a reason, two rows are created at the same time: one for the decision (included: -1) and one for the reason (__EXR__...).
- Rows from rayyan@rayyan.ai (user_id 0) are actions Rayyan took automatically after something a user did, such as adding an article to a sample or moving it to a stage.
Key reference
| Action type | Key | Value |
|---|---|---|
| Screening decision | included | 1 = Included · 0 = Maybe · -1 = Excluded |
| Label | "label name" | 1 = label added · deleted = label removed |
| Exclusion reason | __EXR__[reason text] | 1 = reason added · deleted = reason removed |
| Note | note-[ID] | 1 = note added · deleted = note removed |
| Full text screening decision | included__SYSTEM__STAGE__[ID] | 1 = Included · 0 = Maybe · -1 = Excluded |
| Data Extraction or Risk of Bias answer | included__SYSTEM__STAGE__[ID]__QUESTION__[ID] | JSON with the answer · [] = answer removed |
Continue to: How to Export Data Extraction Results from Rayyan