Skip to main content

A Python package for downsampling sequence alignment files.

Installation

pydownsampler is available through pypi. To install, type:

pip install pydownsampler

Usage

$ pydownsampler (<file>) [-d <dcov>]
$ pydownsampler (<file>) [-d <dcov>] [-o <output>]
$ pydownsampler (<file>) [-c]
$ pydownsampler [-h] | [--help]
$ pydownsampler [-v] [--version]

Arguments and Options

Argument/ Option

Description

-h, --help

Show help message to screen.

-v, --version

Show version.

<file>

Input BAM/CRAM/SAM file

-d, --downcoverage

The coverage you want to downsample to (Required argument)

-o, --output

Output filename prefix (Optional)

-c, --coverage

Check file coverage

Examples

# option 1 (default):
$ pydownsampler input.bam -d 10
In the example above, the file 'input.bam' will be downsampled to 10X coverage. The output filename will be 'input.Downsampled10X.bam'.

# option 2 (optional):
$ pydownsampler input.bam -d 10 -o downsampled

# check coverage of a BAM/CRAM/SAM file
$ pydownsampler input.bam -c

Authors

Lindokuhle Nkambule

Scott Hazelhurst

License

pydownsampler is generously distributed under The MIT License

Release files for pydownsampler 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pydownsampler 1.0
File Size Uploaded
pydownsampler-1.0.tar.gz 4.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pydownsampler 1.0
File Interpreter ABI Platform
pydownsampler-1.0-py2-none-any.whl Python 2 none any Details

Total release size: 10.0 kB

Release files / pydownsampler-1.0.tar.gz

Download URL pydownsampler-1.0.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0c7d5515382f343a058155d713376d9f6d7245d8dcfa603d9dd3acc70c2643d2
BLAKE2b-256 checksum
How to use checksums
8f12d58ce51b9e4900c2b3e0dfaaf9d64d965158292d5c594deb6939b7058805
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.2

Release files / pydownsampler-1.0-py2-none-any.whl

Download URL pydownsampler-1.0-py2-none-any.whl
Size 5.7 kB
Tags Python 2
SHA-256 checksum
How to use checksums
62f5f65a0c1b9784dad2ba67562df11cb21ea50316fe6d7d2a1c8e450ee1bcc4
BLAKE2b-256 checksum
How to use checksums
a91ef6fa39dc9480fa0bd86a622c48f1085ac96e49ce95a9ee06ad8b3efef3e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.2

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page