Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jakelever/pubrunner

A framework for keeping biomedical text mining result up-to-date
https://github.com/jakelever/pubrunner

bionlp infrastructure pubmed pubmed-central python snakemake text-mining

Last synced: 2 months ago
JSON representation

A framework for keeping biomedical text mining result up-to-date

Lists

README

        

# PubRunner

















PubRunner is a framework to keep text mining tools running on the latest publications.

## Installation

PubRunner uses Python3 and can be installed via [pip](https://pypi.python.org/pypi/pip/) from [PyPI](https://pypi.python.org/pypi).

```
pip install pubrunner
```

## Usage

To run Pubrunner, you just need to provide it with a path to a biomedical text mining tool (e.g. a Github repo or a local directory). The flag --test tells Pubrunner to execute the test set. Omitting that gets Pubrunner to run the tool on the full corpus (which for Ab3P is PubMed).::

```
pubrunner --test https://github.com/jakelever/Ab3P
```

## Is PubRunner for me?

Are you a biomedical text mining tool developer? Then likely yes. PubRunner makes it easy to run a text mining tool across PubMed and keep it working!

## Examples

Check out the [examples directory](https://github.com/jakelever/pubrunner/tree/master/examples
) to see a small number of projects that use PubRunner on Pubmed.

## Documentation

Documentation including a tutorial can be found at the [readthedocs](http://pubrunner.readthedocs.io/en/stable/) page.

## Contributing
Contributions are very welcome.

## License

Distributed under the terms of the [MIT](http://opensource.org/licenses/MIT) license, "pubrunner" is free and open source software

## Issues

If you encounter any problems, please [file an issue](https://github.com/jakelever/pubrunner/issues) along with a detailed description.