Skip to main content

Resolwe SDK for Python

Project description

Build Status Documentation Status Version on PyPI Supported Python versions Number of downloads from PyPI

Resolwe is a dataflow package for the Django framework. Resolwe Bioinformatics is an extension of Resolwe that provides bioinformatics pipelines. Resolwe SDK for Python supports writing dataflow pipelines for Resolwe and Resolwe Bioinformatics.

Docs & Help

Read the detailed description in documentation.

Install

Install from PyPI:

pip install resdk

To install for development, fork on Github and run:

git clone https://github.com/<GITHUB_USER>/resolwe-bio-py.git
cd resolwe-bio-py
pip install -e .[docs,package,test]

Quick Start

Connect to a Resolwe server:

from resdk import Resolwe
re = Resolwe('admin', 'admin', 'https://torta.bcm.genialis.com')

Get sample by ID and download the aligned reads (BAM file):

sample = re.sample.get(1)
sample.download(type='bam')

Find human samples and download all aligned reads (BAM files):

samples = re.sample.filter(descriptor__organism="Homo sapiens")
for sample in samples:
    sample.download(type='bam')

Primary analysis (e.g., filtering, alignment, expression estimation) starts automatically when samples are annotated. A step in primary analysis is represented as Data object, attached to the sample. A Sample object includes sample annotation. A Data object includes input parameters, results and analysis annotation. Print the steps in primary analysis pipeline:

for data_id in sample.data:
    data = re.data.get(data_id)
    print data.process_name

Find ROSE2 analysis results and display a ??? plot of the first result:

rose2 = re.data.filter(type='data:chipseq:rose2:')
# TODO: Plot results

Run Bowtie2 mapping on the reads Data object of the above sample:

genome = re.data.filter(type='data:genome:fasta:')[0]
reads = sample.data[0]
aligned = re.run('alignment-bowtie-2-2-3_trim', input={
                     genome: genome.id,
                     reads: reads.id,
                     reporting: {rep_mode: 'k', k_reports: 1}
                 })
aligned.status()

Continue in the Getting Started section of Documentation, where we explain how to upload files, create samples and provide details about the Resolwe backend. Bioinformaticians can learn how to develop pipelines in Writing Pipelines.

Project details


Download files

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

Files for resdk, version 1.3.1
Filename, size File type Python version Upload date Hashes
Filename, size resdk-1.3.1-py2.py3-none-any.whl (36.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size resdk-1.3.1.tar.gz (38.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page