-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
73 changed files
with
577 additions
and
1,038 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,58 @@ | ||
[![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/dputhier/gtftk) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dputhier/gtftk/issues) [![HitCount](http://hits.dwyl.io/puthier/gtftk.svg)](http://hits.dwyl.io/puthier/gtftk) | ||
![GitHub release](https://img.shields.io/github/release/qubyte/rubidium.svg) | ||
[![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/dputhier/pygtftk) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dputhier/pygtftk/issues) [![HitCount](http://hits.dwyl.com/dputhier/pygtftk.svg)](http://hits.dwyl.com/dputhier/pygtftk) | ||
|
||
|
||
# Python GTF toolkit (pygtftk) | ||
|
||
|
||
The **Python GTF toolkit (pygtftk) package** is intented to ease handling of GTF (Gene Transfer Format) files. The pygtftk package is compatible with Python 2.7 and relies on **libgtftk**, a library of functions **written in C**. | ||
The **Python GTF toolkit (pygtftk) package** is intented to ease handling of GTF (Gene Transfer Format) files. The pygtftk package is compatible with Python 2.7 and Python >=3.5 and relies on **libgtftk**, a library of functions **written in C**. | ||
|
||
The package comes with a set of **UNIX commands** that can be accessed through the **gtftk program**. The gtftk program proposes several atomic tools to filter, convert, or extract data from GTF files. The gtftk set of Unix commands can be easily extended using a basic plugin architecture. All these aspects are covered in the help sections. | ||
|
||
While the gtftk Unix program comes with hundreds of unitary and functional tests, it is still upon active development and may thus suffer from bugs that remain to be discovered. Feel free to post any problem or required enhancement in the issue section of the github repository. | ||
|
||
## System requirements | ||
|
||
Depending on the **size of the GTF file**, pygtftk may require lot of memory to perform selected tasks. A computer with 16Go is recommended in order to be able to pipe several commands when working with human annotations from ensembl release (e.g. 91). | ||
Depending on the **size of the GTF file**, pygtftk and gtftk may require lot of memory to perform selected tasks. A computer with 16Go is recommended in order to be able to pipe several commands when working with human annotations from ensembl release (e.g. 91). | ||
|
||
At the moment, the gtftk program has been tested on: | ||
|
||
- Linux (Ubuntu 12.04 and 18.04) | ||
- OSX (Yosemite, El Capitan). | ||
- WSL/Bash on Ubuntu on Windows. | ||
|
||
|
||
## Installation through conda package building | ||
|
||
Installation through **conda** should be the **prefered install solution**. Although the GTF interface of pygtftk should work properly after a pip install (see next section), the UNIX commands (gtftk program) require several external dependencies with some version constrains. | ||
Installation through **conda** should be the **prefered install solution**. The pygtftk package and gtftk command line tool require external dependencies with some version constrains (e.g. bedtools that, we observed, displays some back compatibility issue). | ||
|
||
At the moment, there is no built conda package available. You can however create an environment with all prerequisites using the commands below. | ||
A conda package will be available in the near future. In the meantime, you can however create an environment with all prerequisites using the commands below. | ||
If conda is not available on your system, first install miniconda from the official [web site](http://conda.pydata.org/miniconda.html). | ||
|
||
git clone [email protected]:dputhier/pygtftk.git pygtftk | ||
cd pygtftk | ||
conda env create -n pygtftk_py3k -f conda/env.yaml python=3.6 | ||
source activate pygtftk_py3k | ||
make install | ||
# It is important to call gtftk -h | ||
# to find and dump plugin parsers | ||
# before going further | ||
gtftk -h | ||
|
||
Note for developpers: You can install the develop branch using the same approach. | ||
|
||
git clone [email protected]:dputhier/pygtftk.git pygtftk | ||
cd pygtftk | ||
git checkout develop | ||
conda env create -n pygtftk_py3k_dev -f conda/env.yaml python=3.6 | ||
source activate pygtftk_py3k_dev | ||
make install | ||
|
||
## Installation through pip | ||
|
||
### Prerequesites | ||
|
||
Again, this is not the prefered way for installation. Please choose conda whenever possible. The gtftk Unix command line program requires at least bedtools (command line). | ||
Again, this is not the prefered way for installation. Please choose conda whenever possible. The gtftk Unix command line program has been tested with bedtools 2.27.1 (be aware that we have encountered some back compatibility issues with bedtools). | ||
|
||
### Running pip | ||
|
||
Installation through pip can be done as follow. | ||
|
||
pip install -r requirements.txt | ||
|
||
pip install pygtftk | ||
|
||
# It is important to call gtftk -h | ||
# to find and dump plugin parsers | ||
# before going further | ||
gtftk -h | ||
|
||
## Running functional tests | ||
|
||
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,34 @@ | ||
## Changelog | ||
# Changelog | ||
|
||
### v0.9.2 (not-yet-release) | ||
## v0.9.4 (not-yet-release) | ||
|
||
#### Bug Fixes | ||
### Bug Fixes | ||
|
||
#### API Changes | ||
### API Changes | ||
|
||
### New Features | ||
|
||
#### New Features | ||
|
||
- pygtftk is now compatible with both python 2 and 3. | ||
## v0.9.3 | ||
|
||
### Bug Fixes | ||
|
||
- User-defined colors are now applied when calling profile command (bug in 0.9.2). | ||
- Fixed test issues when using md5sum under Linux. | ||
- Lots of typo fixed (their must be lot remaining unfortunatly...). | ||
|
||
### API Changes | ||
|
||
|
||
### New Features | ||
|
||
- pygtftk is now compatible with both python 2.7 and >=3.5. | ||
- libstdcxx is no more required in env.yaml. | ||
- 'Makefile clean' also reset version.py and conf.py to repository version. | ||
- Improved parser loading. | ||
- 5p_3p_coord has been renamed get_5p_3p_coords. | ||
- Lots of typo fixed (their must be lot remaining unfortunatly...). | ||
- Added a pip requirement.txt file for developers. | ||
- Added a specific conda environment file for py2k. | ||
- The default conda environment targets Python3.6. | ||
- The default conda environment targets Python 3.6. | ||
- Improve garbage collector behavior upon exit. | ||
- Added --system-info argument to gtftk. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 5bba3f85f3e759061303af1056946e93 | ||
config: 3eeb7851cd4315f822ba357e4cc51edd | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.