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,</path/to/file.bed.gz>}] [--names] [--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,</path/to/file.bed.gz>}
genome build or path to BED file [hg38]
--names include sample names in output
--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 [/opt/anaconda3/envs/tssenrich/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.5.tar.gz
(37.8 MB
view hashes)
Built Distribution
tssenrich-1.4.5-py3-none-any.whl
(37.8 MB
view hashes)
Close
Hashes for tssenrich-1.4.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b161dda08428f1b9d07e30e20759ec56346fcc1e26f7655ea10e4f42ae912f62 |
|
MD5 | 348ae29d67579cb0dc5df3fcd586d128 |
|
BLAKE2b-256 | ca9673c184f64168a4cf8ab085123806349f24f87965755c75318160904ebe40 |