Skip to main content

Literature Scanner

Project description

project status version build status coverage license python versions publication

LISC is a package for collecting and analyzing scientific literature.

Overview

LISC wraps and combines existing APIs, allowing users to collect data from and about scientific articles and perform analyses on this data, allowing for automated meta-analyses.

A curated list of some projects enabled by LISC is available on the projects page.

Supported APIs & Collection Approaches

Supported APIs and data collection approaches include:

  • The EUtils API, which provides access to literature data, including the Pubmed database, from which counts, co-occurrences, text, and meta-data from scientific articles can be collected.

  • The OpenCitations API, which provides access to citation data, from which citation and reference information can be collected.

Analysis & Other Functionality

In addition to connecting to external APIs, LISC also provides:

  • A database structure, and save and load utilities for storing collected data

  • Custom data objects for managing and preprocessing collected data

  • Functions and utilities to analyze collected data

  • Data visualization functions for plotting collected data and analysis outputs

Documentation

Documentation is available on the documentation site.

This documentation includes:

  • Tutorials: with a step-by-step guide through the module and how to use it

  • Examples: demonstrating example analyses and use cases, and other functionality

  • API list: which lists and describes all the code and functionality available in the module

  • Reference: with information for how to reference and report on using the module

For a curated list of projects that use LISC, see the projects page.

Dependencies

LISC is written in Python 3, and requires Python >= 3.7 to run.

Requirements:

Optional dependencies, used for plotting, analyses & testing:

Install

Stable releases of LISC are released on the Github release page, and on PYPI.

Descriptions of updates and changes across versions are available in the changelog.

Stable Release Version

To install the latest stable release, you can install from pip:

$ pip install lisc

LISC can also be installed with conda, from the conda-forge channel:

$ conda install -c conda-forge lisc

Development Version

To get the development version (updates that are not yet published to pip), you can clone this repository.

$ git clone https://github.com/lisc-tools/lisc

To install this cloned copy of LISC, move into the directory you just cloned, and run:

$ pip install .

Editable Version

If you want to install an editable version, for making contributions, download the development version as above, and run:

$ pip install -e .

Reference

If you use this code in your project, please cite:

Donoghue, T. (2018)  LISC: A Python Package for Scientific Literature Collection and Analysis.
Journal of Open Source Software, 4(41), 1674. DOI: 10.21105/joss.01674

Direct Link: https://doi.org/10.21105/joss.01674

More information for how to cite this method can be found on the reference page.

Contribute

This project welcomes and encourages contributions from the community!

To file bug reports and/or ask questions about this project, please use the Github issue tracker.

To see and get involved in discussions about the module, check out:

  • the issues board for topics relating to code updates, bugs, and fixes

  • the development page for discussion of potential major updates to the module

When interacting with this project, please use the contribution guidelines and follow the code of conduct.

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

lisc-0.4.0.tar.gz (75.7 kB view details)

Uploaded Source

Built Distribution

lisc-0.4.0-py3-none-any.whl (101.8 kB view details)

Uploaded Python 3

File details

Details for the file lisc-0.4.0.tar.gz.

File metadata

  • Download URL: lisc-0.4.0.tar.gz
  • Upload date:
  • Size: 75.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.3

File hashes

Hashes for lisc-0.4.0.tar.gz
Algorithm Hash digest
SHA256 90c49187c1896076b7e98dabe2094f35eb92413dd870e3c64d5fe6f6f024f387
MD5 928f6979f2bf1aefd930b82a7ed771de
BLAKE2b-256 6a6d102d467614163a42e4f11b40316e14f7b6eb70199e587136e11867e1abc3

See more details on using hashes here.

File details

Details for the file lisc-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: lisc-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 101.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.3

File hashes

Hashes for lisc-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e6851d13131834c50ae169c4f5b786e271b71010b91842671f112dee8d0baa9
MD5 bb8c660a391ac59c4e8734656d4701f9
BLAKE2b-256 d76a9f45446e494fec3be60512b5d0f18c76434ce766628edf55d858d13d97f8

See more details on using hashes here.

Supported by

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