[![DOI](https://zenodo.org/badge/363073613.svg)](https://zenodo.org/badge/latestdoi/363073613)
[![PyPI - Version](https://img.shields.io/pypi/v/colrev?color=blue)](https://pypi.org/project/colrev/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/colrev)
[![License](https://img.shields.io/github/license/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/)
![Documentation Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/docs_deploy.yml?label=documentation)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/tests.yml?label=tests)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/CoLRev-Ecosystem/colrev/main.svg)](https://results.pre-commit.ci/latest/github/CoLRev-Ecosystem/colrev/main)
![Coverage](https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/tests/coverage.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bd4e44c6cda646e4b9e494c4c4d9487b)](https://app.codacy.com/gh/CoLRev-Environment/colrev/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
![GitHub last commit](https://img.shields.io/github/last-commit/CoLRev-Ecosystem/colrev)
[![Downloads](https://static.pepy.tech/badge/colrev/month)](https://pepy.tech/project/colrev)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7148/badge)](https://bestpractices.coreinfrastructure.org/projects/7148)
[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/CoLRev-Environment/colrev/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/CoLRev-Environment/colrev/)
[![All Contributors](https://img.shields.io/badge/all_contributors-32-green.svg?style=flat-square)](#contributors)
Collaborative Literature Reviews (CoLRev)
CoLRev is an open-source environment for collaborative literature reviews. It integrates with differerent synthesis tools, takes care of the data, and facilitates Git-based collaboration.
To accomplish these goals, CoLRev advances the design of review technology at the intersection of methods, design, cognition, and community building.
The following features stand out:
- Supports all literature review steps: problem formulation, search, dedupe, (pre)screen, pdf retrieval and preparation, and synthesis
- An open and extensible environment based on shared data and process standards
- Builds on git and its transparent collaboration model for the entire literature review process
- Offers a self-explanatory, fault-tolerant, and configurable user workflow
- Operates a model for data quality, content curation, and reuse
- Enables typological and methodological pluralism throughout the process
For details, consult the documentation.
Demo
You can try a live demonstration of CoLRev via GitHub codespaces: start demo.
Related work (preview)
The following shows a comparison of CoLRev with related tools.
[!Note]
This is a preview. We plan to document and link the criteria, verify each cell, and invite the developers of the other tools to comment on the overview (documenting responses if the developers agree).
Criteria |
CoLRev |
LitStudy |
BUHOS |
Covidence |
Review types |
|
|
|
|
Supports different genres of review methods |
|
|
|
|
Extensibility |
|
|
|
|
Process steps |
|
|
|
|
Review objectives and protocol |
|
|
|
|
Search |
|
|
|
|
Duplicate handling |
|
|
|
|
(Pre)Screen |
|
|
|
|
Data extraction |
|
|
|
|
Data analysis and quality appraisal |
|
|
|
|
Synthesis and reporting |
|
|
|
|
Process qualities |
|
|
|
|
Extensibility |
|
|
|
|
Extensions |
102 |
0 |
0 |
0 |
Search updates |
|
|
|
|
Search: APIs |
|
|
|
|
Metadata preparation |
|
|
|
|
Retract checks |
|
|
|
|
PDF retrieval |
|
|
|
|
PDF preparation |
|
|
|
|
Status tracking |
|
|
|
|
Collaboration |
|
|
|
|
Large teams |
|
|
|
|
Algorithms |
|
|
|
|
Data management |
|
|
|
|
Transparency |
|
|
|
|
Validation |
|
|
|
|
Reporting (e.g., PRISMA) |
|
|
|
|
Publication of review |
|
|
|
|
Platform |
|
|
|
|
OSI-approved license |
|
|
|
|
Peer-reviewed |
|
|
|
|
Technology |
Python |
Python |
Ruby |
Proprietary |
Setup |
Local or cloud |
Local or cloud |
Server |
Server |
Interface |
CLI, Programmatic (GUI planned) |
Jupyter Notebook |
Web-UI |
Web-UI |
Contributors |
|
|
|
NA |
Commits |
|
|
|
NA |
Last commit |
|
|
|
NA |
Pull requests |
|
|
|
NA |
Forks |
|
|
|
NA |
Last release |
|
|
|
NA |
Current release |
|
|
|
NA |
Contributing, changes, and releases
Contributions, code and features are always welcome
For further information, see tests, changes, and releases.
Contributors
License
This project is distributed under the MIT License the documentation is distributed under the CC-0 license.
If you contribute to the project, you agree to share your contribution following these licenses.
Citing CoLRev
Please cite the project as follows:
Wagner, G. and Prester, J. (2024) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev. doi:10.5281/zenodo.11668338