Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

xenomapper - mapping mixed reads from two species

Project description

Xenomapper

Xenomapper is a utility for post processing mapped reads that have been aligned to a primary genome and a secondary genome and binning reads into species specific, multimapping in each species, unmapped and unassigned bins. It can be used on single end or paired end sequencing data. In paired end data evidence of sequence specificity for either read will be used to assign both reads.

Use cases include xenografts of human cancers and host pathogen interactions.

Xenomapper is most effective with mapped reads that include an XS or ZS score that gives the mapping score of the next best read. These include Bowtie2 (Langmead, 2012) and HISAT (Kim, 2015).

Installation

Xenomapper requires python 3.3 or higher and is tested on linux and MacOS with CPython and pypy3. For bam file decoding samtools must be installed.

Installing from the Python Package Index with pip is the easiest option:

pip3 install xenomapper

Alternatively if you would like to install from the github repository

git clone https://github.com/genomematt/xenomapper
pip3 install --upgrade xenomapper

Although the repository tests by continuous integration with TravisCI its good practice to run the tests locally and check your install works correctly. The tests are run with the following command:

python3 -m xenomapper.tests.test_all

All users should upgrade to v0.5.0 or higher as earlier versions have known bugs.

Citing Xenomapper

Xenomapper is published in the Journal of Open Source Software. Please cite the paper in academic publications DOI:10.21105.joss.00018.

Project details


Release history Release notifications

This version
History Node

1.0.1

History Node

1.0.0

History Node

1.0b5

History Node

1.0b3

History Node

1.0b1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
XenoMapper-1.0.1-py3-none-any.whl (21.2 kB) Copy SHA256 hash SHA256 Wheel py3 May 23, 2016
XenoMapper-1.0.1.tar.gz (15.5 kB) Copy SHA256 hash SHA256 Source None Feb 23, 2018

Supported by

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