Skip to main content

pyrpipe

Project description

Build Status Coverage Status Documentation Status PyPI - Python Version PyPI - Downloads PyPI - License

pyrpipe: python rna-seq pipeliner

Introduction

pyrpipe (Pronounced as "pyre-pipe") is a python package to easily develop RNA-Seq analyses workflow by integrating popular RNA-Seq analysis programs in an object oriented manner. pyrpipe can be used on local computers or on HPC environments to manage analysis of RNA-Seq data. Users can use the easy-to-use APIs to popular bioinformatic tools provided with pyrpipe, or can use the methods provided in the pyrpipe_engine module to integrate any other third-party program in their pipeline.

What it does

Allows fast and easy development of bioinformatics pipelines in python by providing

  • a high level api to popular bioinformatics tools
  • a general api to execute any linux command from python (using the subprocess module)
  • comprehensive logging features to log all the commands, output and their return status
  • report generating features for easy sharing, reproducing, benchmarking and debugging

Prerequisites

  • python 3.6 or higher
  • OS: Linux, Mac

pyrpipe provides API to:

Tool Purpose
SRA Tools (v. 2.9.6 or higher) SRA access
Trimgalore QC
BBDuk QC
Hisat2 Alignment
STAR Alignment
Bowtie2 Alignment
Kallisto Quant
Salmon Quant
Stringtie Transcript Assembly
Cufflinks Transcript Assembly
Trinity Transcript Assembly
Samtools Tools
Portcullis Tools
Mikado Tools

Installation

Please follow these instruction

Install latest stable version

pip install pyrpipe

Install current developer version

git clone https://github.com/urmi-21/pyrpipe.git
pip install -r pyrpipe/requirements.txt
pip install -e path_to/pyrpipe

#Running tests; From pyrpipe root perform

py.test tests/

Setting NCBI SRA Toolkit

Use vdb-config -i to configure SRA Toolkit. Make sure that:

  • Under the TOOLS tab, prefetch downloads to is set to public user-repository
  • Under the CACHE tab, location of public user-repository is not empty

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrpipe-0.0.0.tar.gz (40.4 kB view hashes)

Uploaded Source

Built Distribution

pyrpipe-0.0.0-py3-none-any.whl (52.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page