This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
![logo](logo.png)

# *scikit-ribo*

### - A scikit framework for joint analysis of Riboseq and RNAseq data
--------

## Contact

Han Fang
hanfang.cshl@gmail.com

## Requirement:
Environment: Python3, Linux

Dependencies:
bedtools >= 2.26.0

When using `pip install scikit-ribo`, all the following dependencies will be pulled and installed automatically.

| Python package| Version >= |
| ------------- |:-------------:|
| conda | 4.2.13 |
| colorama | 0.3.7 |
| glmnet-py | 0.1.0b |
| gffutils | 0.8.7.1 |
| matplotlib | 1.5.1 |
| numpy | 1.11.2 |
| pandas | 0.19.2 |
| pybedtools | 0.7.8 |
| pyfiglet | 0.7.5 |
| pysam | 0.9.1.4 |
| scikit-learn | 0.18 |
| scipy | 0.18.1 |
| seaborn | 0.7.0 |
| termcolor | 1.1.0 |

## Install

Install `scikit-ribo`

pip install scikit-ribo

## How-to-use

Twp steps:

- Build index: `scikit-ribo-build.py`

- Fit model: `scikit-ribo-run.py`

## Usage

1. Build index: `scikit-ribo-build.py`


```
scikit-ribo-build.py -g gtf-file -f fasta-file -p prefix -r rna-fold-folder -t TPM-file -o index-path

required arguments:
-g G Gtf file, required
-f F Fasta file, required
-p P Prefix to use, required
-r R Rnafold folder, required
-t T TPM of RNAseq sample, required
-o O Output path of the built indexes, required
```


2. Fit model: `scikit-ribo-run.py`

```
scikit-ribo-run.py -i bam-file -f index-path -p prefix -o output-path

required arguments:
-i I Input bam file
-f F path to the Folder of BED/index files generated by the pre-processing module
-p P Prefix for BED/index files
-o O Output path, recommend using the sample id

optional arguments:
-h, --help show this help message and exit
-q Q minimum mapQ allowed, Default: 20
-s S Shortest read length allowed, Default: 10
-l L Longest read length allowed, Default: 35
-c enable cross validation for glmnet
-r setting this flag will enable the RelE mode
-u U Un-mappable regions
```

## Introduction

## Reference

Preprint coming up


Release History

Release History

0.2.1b5

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
scikit_ribo-0.2.1b5-py3-none-any.whl (69.2 kB) Copy SHA256 Checksum SHA256 py3 Wheel Apr 3, 2017
scikit_ribo-0.2.1b5.tar.gz (22.5 kB) Copy SHA256 Checksum SHA256 Source Apr 3, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting