Metadata-Version: 2.1
Name: uorf4u
Version: 0.8.0
Summary: A tool for short uORF annotation.
Home-page: https://art-egorov.github.io/uorf4u/
Author: Artyom Egorov
Author-email: artem.egorov@med.lu.se
License: WTFPL
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE_dependencies
Requires-Dist: biopython
Requires-Dist: configs
Requires-Dist: argparse
Requires-Dist: statistics
Requires-Dist: logomaker
Requires-Dist: matplotlib
Requires-Dist: pandas (==1.4.0)
Requires-Dist: reportlab


<img  src="https://raw.githubusercontent.com/art-egorov/uorf4u/main/docs/img/uorf4u_logo.png" width="310"/>

## Description

**uORF4u** is a bioinformatics tool for conserved upstream ORF annotation.    

**Programming language:** Python3   
**OS:** MacOS, Linux  
**Python dependencies:** biopython, configs, argparse, pandas, statistics, logomaker, matplotlib, reportlab.  
**OS-level dependencies:** mafft (v7.490 is included in the package)  
**License:** [WTFPL](http://www.wtfpl.net)  
**Version:** 0.8.0 (November 2022)

[**Detailed documentation**](https://art-egorov.github.io/uorf4u)

## Installation 🛠️

- The most stable release of uorf4u can be installed directly from pypi:

```
python3 -m pip install uorf4u
```

- The development version is available at github :

```
git clone https://github.com/art-egorov/uorf4u.git
cd uorf4u
python3 -m pip install --upgrade pip
python3 -m pip install wheel
python3 setup.py sdist bdist_wheel
python3 -m pip install -e .
```

**!** If you're a linux user, run `uorf4u --linux` post-install command once to update paths in the premade config files that set by default for MacOS users.


## Reference 📃

If you find uorf4u useful, please cite:  
Artyom. A. Egorov, Gemma C. Atkinson, **uORF4u: a tool for annotation of conserved upstream open reading frames**, *bioRxiv 2022.10.27.514069; doi: [10.1101/2022.10.27.514069](https://doi.org/10.1101/2022.10.27.514069)*

## Contact 📇

Please contact us by e-mail _artem**dot**egorov**AT**med**dot**lu**dot**se_ or use [Issues](https://github.com/art-egorov/uorf4u/issues?q=) to report any technical problems.  
You can also use [Discussions section](https://github.com/art-egorov/uorf4u/discussions) for sharing your ideas or feature requests! 
## Authors 👨🏻‍💻

uORF4u is developed by Artyom Egorov at [the Atkinson Lab](https://atkinson-lab.com), Department of Experimental Medical Science, Lund University, Sweden 🇸🇪. We are open for suggestions to extend and improve svist4get functionality. Please don't hesitate to share your ideas or feature requests.
