litstudy

LitStudy: Using the power of Python to automate scientific literature analysis from the comfort of a Jupyter notebook

Science Score: 77.0%

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

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 2 DOI reference(s) in README
✓
Academic publication links
Links to: arxiv.org, sciencedirect.com, springer.com, ieee.org, zenodo.org
✓
Committers with academic emails
1 of 13 committers (7.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

bibliographics bibliometric-analysis bibliometric-visualization bibliometrics jupyter literature-review literature-review-tool literature-search python scientometrics systematic-literature-reviews systematic-reviews

Last synced: 6 months ago · JSON representation ·

Repository

LitStudy: Using the power of Python to automate scientific literature analysis from the comfort of a Jupyter notebook

Basic Info

Host: GitHub
Owner: NLeSC
License: apache-2.0
Language: Python
Default Branch: master
Homepage: https://nlesc.github.io/litstudy/
Size: 21 MB

Statistics

Stars: 196
Watchers: 8
Forks: 56
Open Issues: 32
Releases: 9

Topics

Created over 6 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Zenodo

README.md

LitStudy

LitStudy is a Python package for analyzing scientific literature right from the comfort of a Jupyter Notebook. It lets you gather publications and explore their metadata through visualizations, network analysis, and natural-language processing.

The package offers five main features:

Extract metadata from scientific documents sourced from various locations. A uniform interface allows combining different data sources.
Filter, select, deduplicate, and annotate document collections.
Compute and plot general statistics for document sets (authors, venues, publication years, and more).
Generate and plot various bibliographic networks as interactive visualizations.
Discover topics using natural-language processing (NLP) to automatically identify popular themes.

Frequently Asked Questions

If you have any questions or run into an error, see the Frequently Asked Questions section of the documentation. If your question or error is not on the list, please check the GitHub issue tracker for a similar issue or create a new issue.

Supported Source

LitStudy supports the following data sources. The table below lists which metadata is fully (✓) or partially (*) provided by each source.

| Name | Title | Authors | Venue | Abstract | Citations | References | |-----------------|-------|---------|-------|----------|----------------|------------| | Scopus | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | SemanticScholar | ✓ | ✓ | ✓ | ✓ | * ^{(count only)} | ✓ | CrossRef | ✓ | ✓ | ✓ | ✓ | * ^{(count only)} | ✓ | DBLP | ✓ | ✓ | ✓ | | | | arXiv | ✓ | ✓ | | ✓ | | | IEEE Xplore | ✓ | ✓ | ✓ | ✓ | * ^{(count only)} | | Springer Link | ✓ | ✓ | ✓ | ✓ | * ^{(count only)} | | CSV file | ✓ | ✓ | ✓ | ✓ | | | bibtex file | ✓ | ✓ | ✓ | ✓ | | | RIS file | ✓ | ✓ | ✓ | ✓ | |

Example

An example notebook is available in notebooks/example.ipynb and here.

Installation Guide

LitStudy is available on PyPI! Full installation guide is available here.

bash pip install litstudy

Or install the latest development version directly from GitHub:

bash pip install git+https://github.com/NLeSC/litstudy

Documentation

Documentation is available here.

Requirements

The package has been tested for Python 3.7. Required packages are available in requirements.txt.

litstudy supports several data sources. Some of these sources (such as semantic Scholar, CrossRef, and arXiv) are openly available. However to access the Scopus API, you (or your institute) requires a Scopus subscription and you need to request an Elsevier Developer API key (see Elsevier Developers). For more information, see the guide by pybliometrics.

License

Apache 2.0. See LICENSE.

Change log

See CHANGELOG.md.

Contributing

See CONTRIBUTING.md.

Citation

If you use LitStudy in your work, please cite the following publication:

S. Heldens, A. Sclocco, H. Dreuning, B. van Werkhoven, P. Hijma, J. Maassen & R.V. van Nieuwpoort (2022), "litstudy: A Python package for literature reviews", SoftwareX 20

As BibTeX:

Latex @article{litstudy, title = {litstudy: A Python package for literature reviews}, journal = {SoftwareX}, volume = {20}, pages = {101207}, year = {2022}, issn = {2352-7110}, doi = {https://doi.org/10.1016/j.softx.2022.101207}, url = {https://www.sciencedirect.com/science/article/pii/S235271102200125X}, author = {S. Heldens and A. Sclocco and H. Dreuning and B. {van Werkhoven} and P. Hijma and J. Maassen and R. V. {van Nieuwpoort}}, }

Related work

Don't forget to check out these other amazing software packages!

ScientoPy: Open-source Python based scientometric analysis tool.
pybliometrics: API-Wrapper to access Scopus.
ASReview: Active learning for systematic reviews.
metaknowledge: Python library for doing bibliometric and network analysis in science.
tethne: Python module for bibliographic network analysis.
VOSviewer: Software tool for constructing and visualizing bibliometric networks.

Owner

Name: Netherlands eScience Center
Login: NLeSC
Kind: organization
Location: Amsterdam, The Netherlands

Website: https://esciencecenter.nl
Repositories: 206
Profile: https://github.com/NLeSC

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: litstudy
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Stijn
    family-names: Heldens
    email: s.heldens@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-8792-6305'
  - given-names: Alessio
    family-names: Sclocco
    email: a.sclocco@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0003-3278-0518'
  - given-names: Henk
    family-names: Dreuning
    email: h.h.h.dreuning@vu.nl
    affiliation: University of Amsterdam
identifiers:
  - type: doi
    value: 10.5281/zenodo.3386071
doi: 10.5281/zenodo.3386071
repository-code: 'https://github.com/NLeSC/litstudy/'
url: 'https://nlesc.github.io/litstudy/'
keywords:
  - python
  - jupyter
  - literature-review
license: Apache-2.0

GitHub Events

Total

Issues event: 1
Watch event: 31
Issue comment event: 1
Push event: 7
Fork event: 7

Last Year

Issues event: 1
Watch event: 31
Issue comment event: 1
Push event: 7
Fork event: 7

Committers

Last synced: 9 months ago

All Time

Total Commits: 297
Total Committers: 13
Avg Commits per committer: 22.846
Development Distribution Score (DDS): 0.3

Past Year

Commits: 2
Committers: 1
Avg Commits per committer: 2.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Stijn	s**s@e**l	208
Alessio Sclocco	a**o@e**l	45
Henk	5****r	16
Lars O Grobe	3****e	14
Abel Soares Siqueira	a**a@g**m	2
E. G. Patrick Bos	e**s@g**m	2
Ettore Aquino	e**e@e**m	2
Travis	t**t@g**m	2
scsi	s**i@d**4	2
Martin Uray	m**y@f**t	1
Roberto Chang	r**h@g**m	1
Ruud Steltenpool	g**m@s**m	1
danibene	3****e	1

Committer Domains (Top 20 + Academic)

esciencecenter.nl: 2 steltenpower.com: 1 fh-salzburg.ac.at: 1 ettoreaquino.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 63
Total pull requests: 24
Average time to close issues: about 1 month
Average time to close pull requests: 6 days
Total issue authors: 28
Total pull request authors: 17
Average comments per issue: 2.3
Average comments per pull request: 1.08
Merged pull requests: 19
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 3
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 17 minutes
Issue authors: 3
Pull request authors: 1
Average comments per issue: 2.33
Average comments per pull request: 1.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

stijnh (16)
SS159 (6)
larsgrobe (5)
FlashFFF (3)
r-wrobel (3)
ettoreaquino (2)
rjavierch (2)
semmyk-research (2)
riddhis5 (2)
Haythamyounus (2)
colinmiller20 (2)
tleedepriest (1)
isazi (1)
JFrandon (1)
judiths1618 (1)

Pull Request Authors

larsgrobe (5)
stijnh (4)
r-wrobel (2)
egpbos (2)
isazi (2)
danibene (2)
tleedepriest (2)
abelsiqueira (1)
semmyk-research (1)
rjavierch (1)
dependabot[bot] (1)
ksilo (1)
giuliostramondo (1)
ettoreaquino (1)
steltenpower (1)

Top Labels

Issue Labels

bug (17) enhancement (13) help wanted (11) good first issue (6) invalid (1)

Pull Request Labels

dependencies (1) python (1)

Packages

Total packages: 1
Total downloads:
- pypi 107 last-month

Total dependent packages: 1
Total dependent repositories: 1
Total versions: 8
Total maintainers: 2

pypi.org: litstudy

Using the power of Python and Jupyter notebooks to automate analysis of scientific literature

Homepage: https://github.com/nlesc/litstudy
Documentation: https://litstudy.readthedocs.io/
License: Apache 2.0
Latest release: 1.0.6
published over 2 years ago

Versions: 8
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 107 Last month

Rankings

Dependent packages count: 4.6%

Forks count: 6.6%

Stargazers count: 7.0%

Average: 10.6%

Downloads: 13.0%

Dependent repos count: 21.9%

Maintainers (2)

isazi stijnh

Last synced: 6 months ago

Dependencies

requirements.txt pypi

bibtexparser *
feedparser *
gensim *
matplotlib *
networkx *
numpy *
pandas *
pybliometrics *
pyvis *
requests *
seaborn *
sklearn *
unidecode *
wordcloud *

.github/workflows/cffconvert.yml actions

actions/checkout v2 composite
citation-file-format/cffconvert-github-action 2.0.0 composite

.github/workflows/docs.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
ad-m/github-push-action master composite
sphinx-notes/pages v2 composite

.github/workflows/python-action.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite