Skip to content

CoLRev-Environment/colrev

Repository files navigation

DOI PyPI - Version PyPI - Python Version License Documentation Status GitHub Workflow Status pre-commit.ci status Coverage Codacy Badge GitHub last commit Downloads OpenSSF Best Practices SWH All 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

Demo

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 yes no no no
Extensibility yes maybe maybe no
Process steps
Review objectives and protocol yes yes yes yes
Search yes yes yes yes
Duplicate handling yes no maybe maybe
(Pre)Screen yes maybe yes yes
Data extraction yes maybe yes yes
Data analysis and quality appraisal yes maybe yes yes
Synthesis and reporting yes yes yes yes
Process qualities
Extensibility yes yes no no
Extensions 102 0 0 0
Search updates yes no maybe maybe
Search: APIs yes yes yes no
Metadata preparation yes yes yes maybe
Retract checks yes no no yes
PDF retrieval yes no no yes
PDF preparation yes no maybe maybe
Status tracking yes no yes yes
Collaboration
Large teams yes maybe maybe maybe
Algorithms yes yes maybe maybe
Data management
Transparency yes no no no
Validation yes no no no
Reporting (e.g., PRISMA) yes no yes yes
Publication of review yes yes no no
Platform
OSI-approved license yes yes yes no
Peer-reviewed no yes yes no
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 GitHub contributors GitHub contributors GitHub contributors NA
Commits GitHub total commits GitHub total commits GitHub total commits NA
Last commit GitHub last commit GitHub last commit GitHub last commit NA
Pull requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests NA
Forks GitHub forks GitHub forks GitHub forks NA
Last release GitHub last release GitHub last release GitHub last release NA
Current release Releases Releases GitHub Release NA

Contributing, changes, and releases

Contributions, code and features are always welcome

For further information, see tests, changes, and releases.

Contributors

Gerit Wagner
Gerit Wagner

πŸ’» πŸ“– πŸ”£ πŸ–‹ πŸ’‘
Julian Prester
Julian Prester

πŸ’» πŸ“– πŸ”£ πŸ–‹ πŸ› πŸ€”
Tarin Mahmood
Tarin Mahmood

πŸ’» ⚠️ πŸ“–
dengdenglele
dengdenglele

πŸ”£ πŸ“– ⚠️
mhlbrsimon
mhlbrsimon

πŸ’»
ossendorfluca
ossendorfluca

πŸ’»
katharinaernst
katharinaernst

πŸ’»
einfachjessi
einfachjessi

πŸ’»
Janus678
Janus678

πŸ’»
frxdericz
frxdericz

πŸ’»
MalouSchmidt
MalouSchmidt

πŸ’»
RheaDoesStuff
RheaDoesStuff

πŸ’»
Cohen2000
Cohen2000

πŸ’»
RobertAhr
RobertAhr

πŸ’»
ThomasFleischmann
ThomasFleischmann

πŸ’»
AntonFrisch
AntonFrisch

πŸ’»
LouisLangenhan
LouisLangenhan

πŸ’» πŸ“–
Peter Eckhardt
Peter Eckhardt

πŸ’» πŸ“–
User123projekt
User123projekt

πŸ’» πŸ“–
LuminousLynx
LuminousLynx

πŸ’» πŸ“–
koljarinne
koljarinne

πŸ’»
Karl Schnickmann
Karl Schnickmann

πŸ’»
edensarrival
edensarrival

πŸ’»
U1TIM4T3
U1TIM4T3

πŸ’»
Anna Geßler
annaglr

πŸ’»
0xmtyset
0xmtyset

πŸ’»
tobiaspffl
tobiaspffl

πŸ’»
CelinaSchwarz
CelinaSchwarz

πŸ’»
QuynhMaiNguyen
QuynhMaiNguyen

πŸ’»
pmao0907
pmao0907

πŸ’»
MingxinJiang
MingxinJiang

πŸ’»
JohannesDiel
JohannesDiel

πŸ’»

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