This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Analysis of nanopore sequencing data.

Project Description

Summary

This package provides tools for the analysis of raw nanopore sequencing data, including correction of basecalls and visualization.

Full Documentation

Full documentation avaialable at Read the Docs: https://nanoraw.readthedocs.io

Installation

Install nanoraw without plotting dependencies (base genome_resquiggle algorithm and text outputs: wig and fasta)

pip install nanoraw

Install nanoraw with plotting dependencies (requires separate installation of R packages ggplot2 and cowplot)

pip install nanoraw[plot]

Install nanoraw via pip

pip install nanoraw

Install bleeding edge via github

pip install git+https://github.com/marcus1487/nanoraw.git

Usage

nanoraw -h
nanoraw [command] [options]

Main Command (Must be run before any other commands):

  • genome_resquiggle: Re-annotate raw signal with genomic aignement of existing basecalls.

Genome Anchored Plotting Commands:

  • plot_max_coverage: Plot signal in regions with the maximum coverage.
  • plot_genome_location: Plot signal at defined genomic locations.
  • plot_motif_centered: Plot signal at regions centered on a specific motif.
  • plot_max_difference: Plot signal where signal differs the most between two groups.
  • plot_most_significant: Plot signal where signal differs the most significantly between two groups.
  • plot_motif_with_stats: Plot signal from several regions and test statistics centered on a motif of interst.

Sequencing Time Anchored Plotting Command:

  • plot_correction: Plot segmentation before and after correction.
  • plot_multi_correction: Plot multiple raw signals anchored by genomic location.

Other Plotting Command:

  • plot_kmer: Plot signal quantiles acorss kmers.
  • cluster_most_significant: Clustering traces at bases with significant differences.

Auxiliary Command:

  • write_most_significant_fasta: Write sequence where signal differs the most significantly between two groups.

  • write_wiggles : Write wiggle files for nanopore signal values, coverage, and statistics.

    Get additional help for subcommands with nanoraw [command] -h

Requirements

python Requirements:

  • numpy
  • scipy
  • h5py

Optional plotting packages (install R packages with install.packages([package_name]) from an R prompt):

  • rpy2 (python package; with R installation)
  • ggplot2 (required for all plotting subcommands)
  • cowplot (required for plot_motif_with_stats subcommand)

Citation

Stoiber, M.H. et al. De novo Identification of DNA Modifications Enabled by Genome-Guided Nanopore Signal Processing. bioRxiv (2016).

http://biorxiv.org/content/early/2017/04/10/094672

Release History

Release History

This version
History Node

0.4.2

History Node

0.4.1

History Node

0.4

History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

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