Metadata-Version: 2.1
Name: ribotools
Version: 1.0.3
Summary: Ribo-seq analysis tools associated with the Rp-Bp package and more
Author: Etienne Boileau
Maintainer-email: Etienne Boileau <boileau@uni-heidelberg.de>
License: MIT
Project-URL: Github, https://github.com/eboileau/ribotools/
Project-URL: Issues, https://github.com/eboileau/ribotools/issues
Keywords: bioinformatics,riboseq,open reading frame discovery,translation
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: <3.11,>=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rpbp >=3.0.1
Requires-Dist: htseq >=2.0.2
Provides-Extra: docs
Requires-Dist: ipykernel ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: pandoc ; extra == 'docs'
Requires-Dist: sphinx >=4.5.0 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'docs'
Requires-Dist: furo ; extra == 'docs'
Requires-Dist: sphinx-argparse ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-depends ; extra == 'tests'

# Ribotools

**Ribotools**, an _add-on_ to [Rp-Bp](http://rp-bp.readthedocs.io/en/latest/), is a toolbox for the analysis of matched ribosome profiling (Ribo-seq) and RNA sequencing (RNA-seq) data.

**Ribotools** can be used to generate count tables, starting from raw, trimmed reads, or existing alignments, taking into consideration Ribo-seq periodicity estimates and RNA-seq fragment length. **Ribotools** include scripts to perform translation efficiency (TE) analysis, accommodating for sample-to-sample variance, complex experimental designs, or confounding factors, and classifies features into different regulatory layers.

<p align="center">
  <a href="https://ribotools.readthedocs.io/en/latest"><img alt="Ribotools" src="https://github.com/eboileau/ribotools/raw/master/docs/source/_static/ribotools-logo-light.png"></a>
</p>

<p align="center">
<a href="https://pypi.org/project/ribotools/"><img alt="PyPI" src="https://img.shields.io/pypi/v/ribotools"></a>
<a href='https://ribotools.readthedocs.io/en/latest/?badge=latest'>
    <img src='https://readthedocs.org/projects/ribotools/badge/?version=latest' alt='Documentation Status' />
</a>
</p>

---

## Documentation

Consult the [user guide](https://ribotools.readthedocs.io/en/latest) for instructions on how to install the package and detailed usage instructions.

## How to report issues

For bugs, issues, or feature requests, use the [bug tracker](https://github.com/eboileau/ribotools/issues). Follow the instructions and guidelines given in the templates.

## License

The MIT License (MIT). Copyright (c) 2019 Etienne Boileau.
