colrev

CoLRev: An open-source environment for collaborative reviews

https://github.com/colrev-environment/colrev

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    11 of 37 committers (29.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary

Keywords

literature open-science openscience reproducible-research research systematic-literature-review systematic-review

Keywords from Contributors

energy-system-model energy-system particle meshes transformation parallel standards battery interpretability tensor
Last synced: 6 months ago · JSON representation

Repository

CoLRev: An open-source environment for collaborative reviews

Basic Info
Statistics
  • Stars: 35
  • Watchers: 8
  • Forks: 53
  • Open Issues: 39
  • Releases: 31
Topics
literature open-science openscience reproducible-research research systematic-literature-review systematic-review
Created almost 5 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

[![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/) ![GitHub contributors](https://img.shields.io/github/contributors-anon/CoLRev-Environment/colrev) # 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 | 106 | 0 | 0 | 0 | | Search updates | yes | no | maybe | maybe | | Search: APIs | yes | yes | no | 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 Geler
annaglr

0xmtyset
0xmtyset

tobiaspffl
tobiaspffl

CelinaSchwarz
CelinaSchwarz

QuynhMaiNguyen
QuynhMaiNguyen

pmao0907
pmao0907

MingxinJiang
MingxinJiang

JohannesDiel
JohannesDiel

julialopezmarti
julialopezmarti

olgagirona
olgagirona

komashevska
komashevska

trathienphuc-tran
trathienphuc-tran

ammar-uni
ammar-uni

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

Owner

  • Name: CoLRev-Environment
  • Login: CoLRev-Environment
  • Kind: organization

GitHub Events

Total
  • Create event: 83
  • Release event: 2
  • Issues event: 7
  • Watch event: 8
  • Delete event: 75
  • Issue comment event: 27
  • Push event: 479
  • Pull request event: 195
  • Fork event: 23
Last Year
  • Create event: 83
  • Release event: 2
  • Issues event: 7
  • Watch event: 8
  • Delete event: 75
  • Issue comment event: 27
  • Push event: 479
  • Pull request event: 195
  • Fork event: 23

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 3,006
  • Total Committers: 37
  • Avg Commits per committer: 81.243
  • Development Distribution Score (DDS): 0.571
Past Year
  • Commits: 1,679
  • Committers: 32
  • Avg Commits per committer: 52.469
  • Development Distribution Score (DDS): 0.42
Top Committers
Name Email Commits
Gerit Wagner g****r@h****a 1,291
Gerit Wagner g****r@u****e 973
dengdenglele c****g@w****e 123
Tarin Mahmood 3****d 96
pre-commit-ci[bot] 6****] 84
Gerit Wagner g****r@w****e 66
Gerit Wagner g****r 51
Julian Prester j****n@j****m 39
MalouSchmidt 1****t 36
Thomas Fleischmann t****n@s****e 31
allcontributors[bot] 4****] 28
Alexa_St a****r@i****m 28
Dan Dobriceanu d****u@g****m 22
ossendorfluca l****a@o****e 18
Poetry updater a****s 16
dependabot[bot] 4****] 15
Anton Frisch a****h@s****e 14
RobertAhr r****t@a****e 12
Cohen2000 a****t@g****m 11
einfachjessi j****n@i****m 11
Janus678 1****8 6
Janus678 j****n@s****e 5
katharinaernst k****t@g****e 5
Rhea Nguyen r****n@s****e 4
Carlo Tang c****g@s****e 3
frxdericz f****l@f****e 3
Julian Prester hi@j****m 2
MalouSchmidt m****t@w****e 2
Tester l****h@s****e 2
ba066080 a****t@s****e 2
and 7 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 75
  • Total pull requests: 583
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 5
  • Total pull request authors: 54
  • Average comments per issue: 1.59
  • Average comments per pull request: 0.21
  • Merged pull requests: 319
  • Bot issues: 0
  • Bot pull requests: 373
Past Year
  • Issues: 5
  • Pull requests: 214
  • Average time to close issues: 1 minute
  • Average time to close pull requests: 3 days
  • Issue authors: 1
  • Pull request authors: 43
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.22
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 95
Top Authors
Issue Authors
  • geritwagner (48)
  • julianprester (19)
  • blairw (3)
  • github-actions[bot] (2)
  • jkitchin (2)
  • dengdenglele (1)
Pull Request Authors
  • github-actions[bot] (374)
  • pre-commit-ci[bot] (154)
  • geritwagner (89)
  • dependabot[bot] (37)
  • allcontributors[bot] (35)
  • tmahmood (32)
  • dengdenglele (11)
  • julianprester (8)
  • CelinaSchwarz (4)
  • pmao0907 (4)
  • olgagirona (2)
  • kanekiNeil28 (2)
  • JhosuaGit (2)
  • Justine773 (2)
  • julialopezmarti (2)
Top Labels
Issue Labels
enhancement (59) good first issue (19) search_source (12) bug (9) question (3) documentation (1)
Pull Request Labels
dependencies (37) python (31) codex (22) javascript (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 415 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 1
  • Total versions: 25
  • Total maintainers: 2
pypi.org: colrev

CoLRev: An open-source environment for collaborative reviews

  • Versions: 25
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 415 Last month
Rankings
Dependent packages count: 7.3%
Forks count: 9.9%
Downloads: 11.5%
Average: 13.0%
Stargazers count: 14.2%
Dependent repos count: 22.1%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/poetry_update.yml actions
  • actions/checkout v3 composite
  • repo-sync/pull-request v2 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
poetry.lock pypi
  • 186 dependencies
pyproject.toml pypi
  • GitPython ^3.1.29
  • Jinja2 ^3.1.2
  • PyPDF2 ^1.28.6
  • PyYAML ^6.0.0
  • Sphinx ^5.2.3
  • alphabet-detector ^0.0.7
  • beautifulsoup4 ^4.11.1
  • click ^8.1.6
  • click-repl ^0.3.0
  • click_completion ^0.5.2
  • colrev-asreview ^0.1.0
  • coverage ^7.3.2
  • crossrefapi ^1.5.0
  • dacite ^1.6.0
  • daff ^1.3.46
  • dash ^2.11.1
  • dataclasses-jsonschema ^2.15.3
  • dedupe 2.0.23
  • defusedxml ^0.7.1
  • dictdiffer ^0.9.0
  • docker 6.0.0
  • feedparser ^6.0.10
  • glom ^22.1.0
  • imagehash ^4.3.1
  • inquirer ^3.1.3
  • levenshtein ^0.21.0
  • lingua-language-detector >1.3
  • lxml ^4.9.1
  • m2r ^0.3.1
  • nameparser ^1.1.2
  • openpyxl ^3.1.2
  • pandas ^1.5.0
  • pandasql ^0.7.3
  • pdfminer.six ^20220524
  • pre-commit ^2.20.0
  • psutil ^5.9.2
  • pyalex ^0.10
  • pybtex ^0.24.0
  • pycountry ^22.3.5
  • pylint 3.0.1
  • pymupdf ^1.22.0
  • pytest ^7.2.1
  • pytest-mock ^3.10.0
  • python >=3.8, <4
  • repoze-sphinx-autointerface ^1.0.0
  • requests ^2.28.1
  • requests-cache ^0.9.6
  • requests-mock ^1.10.0
  • sphinx-autodoc-typehints ^1.19.4
  • sphinx-click ^4.3.0
  • sphinx-rtd-theme ^1.1.1
  • sphinx_collapse ^0.1.2
  • sphinxcontrib.datatemplates ^0.9.2
  • thefuzz ^0.19.0
  • tqdm ^4.64.1
  • transitions ^0.8.11
  • types-click ^7.1.8
  • zope.interface ^5.5.0
.github/workflows/make_docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v2 composite