Metadata-Version: 2.1
Name: gtracks
Version: 1.0.7
Summary: Plot genome track data
Home-page: https://github.com/anthony-aylward/gtracks.git
Author: Anthony Aylward
Author-email: aaylward@eng.ucsd.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: deeptools
Requires-Dist: seaborn

# gtracks

plot genome track data (for example from BigWig files)

## Installation

```sh
pip3 install gtracks
```
or
```sh
pip3 install --user gtracks
```

## Usage

```
usage: gtracks [-h] [--genes <genes.bed.gz>]
               [--color-palette <#color> [<#color> ...]] [--max <float>]
               [--tmp-dir <temp/file/dir>] [--width <int>]
               [--genes-height <int>] [--gene-rows <int>]
               <{chr:start-end,GENE}> [<track.bw> [<track.bw> ...]]
               <path/to/output.{pdf,png,svg}

Plot BigWig signal tracks and gene annotations in a genomic region

positional arguments:
  <{chr:start-end,GENE}>
                        coordinates or gene name to plot
  <track.bw>            BigWig files containing tracks
  <path/to/output.{pdf,png,svg}>
                        path to output file

optional arguments:
  -h, --help            show this help message and exit
  --genes <genes.bed.gz>
                        compressed 6-column BED file or 12-column BED12 file
                        containing gene annotations
  --color-palette <#color> [<#color> ...]
                        color pallete for tracks
  --max <float>         max value of y-axis
  --tmp-dir <temp/file/dir>
                        directory for temporary files
  --width <int>         width of plot in cm
  --genes-height <int>  height of genes track
  --gene-rows <int>     number of gene rows
```

## Examples

```sh
gtracks chr21:33031597-33041570 track1.bw track2.bw output.pdf
gtracks SOD1 track1.bw track2.bw output.png

export GTRACKS_TRACKS=track1.bw,track2.bw
gtracks SOD1 output.svg
```


