Skip to main content

CoLRev: An open-source environment for collaborative reviews

Project description

Collaborative Literature Reviews (CoLRev)

DOI GitHub release PyPI - Version PyPI - Python Version License pre-commit Documentation Status GitHub Workflow Status pre-commit.ci status Coverage Codacy Badge GitHub last commit Downloads OpenSSF Best Practices SWH All Contributors

Summary

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

See the documentation and statements of development status for more details. A brief overview presented at ESMARConf2023 is available on YouTube.

Demo

A live demonstration is available via GitHub codespaces: start demo.

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

💻 📖

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colrev-0.12.1.tar.gz (572.2 kB view hashes)

Uploaded Source

Built Distribution

colrev-0.12.1-py3-none-any.whl (775.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page