Calculate TSS enrichment for ATAC-seq data
Project description
tssenrich
Calculate TSS enrichment for ATAC-seq data. (see also the ENCODE standards)
Installation
pip install tssenrich
or
pip install --user tssenrich
Usage
usage: tssenrich [-h] [--genome {hg38,hg19,mm10}] [--memory <float>]
[--processes <int>] [--mapping-quality <int>]
[--samtools-path <path/to/samtools>]
[--log <path/to/log.txt>] [--tmp-dir <temp/file/dir/>]
[--flank-distance <int>] [--flank-size <int>]
<path/to/file.bam> [<path/to/file.bam> ...]
calculate TSS enrichment for ATAC-seq data
positional arguments:
<path/to/file.bam> Path to input BAM file
optional arguments:
-h, --help show this help message and exit
--genome {hg38,hg19,mm10}
genome build [hg38]
--memory <float> memory limit in GB [2]
--processes <int> number of processes/threads to use [1]
--mapping-quality <int>
ignore reads with mapping quality below the given value [0]
--samtools-path <path/to/samtools>
path to an alternate samtools executable [/usr/local/bin/samtools]
--log <path/to/log.txt>
path to log file
--tmp-dir <temp/file/dir/>
directory to use for temporary files
--flank-distance <int>
distance from tss of outer ends of flanks [1000]
--flank-size <int> size of flanks (for determining average depth) [100]
ENCODE standards:
| Genome | Concerning | Acceptable | Ideal |
| ------ | ---------- | ---------- | ----- |
| hg19 | < 6 | 6 - 10 | > 10 |
| hg38 | < 5 | 5 - 7 | > 7 |
| mm10 | < 10 | 10 - 15 | > 15 |
Examples
tssenrich example.bam > score.txt
tssenrich --genome hg19 --log log.txt --memory 2 --processes 2 example1.bam example2.bam > scores.txt
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tssenrich-1.4.0.tar.gz
(37.7 MB
view hashes)
Built Distribution
tssenrich-1.4.0-py3-none-any.whl
(37.7 MB
view hashes)
Close
Hashes for tssenrich-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c707d0814a296f238e07567a8292991f9d423efb0390ac285e80a4d34950737 |
|
MD5 | c0a32e2ab32dd5a75d8cdbd955d3f8f7 |
|
BLAKE2b-256 | 015bf6e40b578aa98d1b568169057e504a5a58b9aff5324618f8e305d8247146 |