Skip to main content

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

Release files for tssenrich 1.4.6

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

Source distribution (sdist)

Source distribution for tssenrich 1.4.6
File Size Uploaded
tssenrich-1.4.6.tar.gz 37.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for tssenrich 1.4.6
File Interpreter ABI Platform
tssenrich-1.4.6-py3-none-any.whl Python 3 none any Details

Total release size: 75.5 MB

Release files / tssenrich-1.4.6.tar.gz

Download URL tssenrich-1.4.6.tar.gz
Size 37.8 MB
Tags Source
SHA-256 checksum
How to use checksums
01f3b8ab7a6576e40bd2820b271fe1c041ed7fcc5b33bea8b5f8ab96675c10a2
BLAKE2b-256 checksum
How to use checksums
90d63ca2a38b784081dae91c7d1c5746ca651482eecfac3b91d070005837ae18
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.10

Release files / tssenrich-1.4.6-py3-none-any.whl

Download URL tssenrich-1.4.6-py3-none-any.whl
Size 37.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
058a10ec5fcd18c10ed5190916d5ea853538d3fb63f64833f640fff66e0594d1
BLAKE2b-256 checksum
How to use checksums
5ab55aa35f08dfa6eb79b19ff9ed2795f6c2c1919472dc789f53aa3fdf6a2729
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.10

Release history Release notifications | RSS feed

This release

1.4.6 This release

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

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