Skip to main content

CLI library to generate UCSC trackhubs from sequencing data

Project description

TrackNado

Simple command line tool to quickly generate a UCSC hub from a set of files.

Installation

git clone https://github.com/alsmith151/Tracknado.git
cd TrackNado
pip install .

Usage

See the help for more details on the options that can be provided.

tracknado --help

Example

Minimal example with no track details

tracknado \
create \ 
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name hg38 \
-o /datashare/asmith/ \
-i bigwigs/deeptools/*.bigWig peaks/lanceotron/*.bigBed

Example with track details

tracknado \
create \
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name hg38 \
-o /datashare/asmith/ \
-d PATH_TO_TRACK_DETAILS_FILE \

Example with a custom genome

tracknado \
create \
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name CUSTOM_GENOME_NAME \
--genome-organism CUSTOM_GENOME_ORGANISM \
--genome-two-bit-path PATH_TO_TWO_BIT_FILE \
-i bigwigs/deeptools/*.bigWig peaks/lanceotron/*.bigBed
-o /datashare/asmith/ \

Merging hubs

It is possible to merge the outputs from tracknado create into a single hub by using the merge command. This requires that hubs have been created with the --save-hub-design flag. This will create a file called hub_design.pkl in the output directory. This file contains all the information required to recreate the hub. This does require that the hubs are for the same genome.

First create a couple of example hubs as above:

tracknado \
create \
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name hg38 \
-o /datashare/asmith/path1 \
-i bigwigs/deeptools/*.bigWig peaks/lanceotron/*.bigBed \
--save-hub-design
tracknado \
create \
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name hg38 \
-o /datashare/asmith/path2 \
-i bigwigs/deeptools/*.bigWig peaks/lanceotron/*.bigBed \
--save-hub-design

Then merge them:

tracknado \
merge \
--hub-name HUB_NAME_HERE \
--hub-email EMAIL_ADDRESS \
--genome-name hg38 \
-o /datashare/asmith/merged \
-i /datashare/asmith/path1/hub_design.pkl /datashare/asmith/path2/hub_design.pkl

This will create a new hub in /datashare/asmith/merged that contains all the tracks from the two input hubs. You can also supply all of the standard arguments to the merge command to change the hub name, email, genome etc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tracknado-0.2.3.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

tracknado-0.2.3-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file tracknado-0.2.3.tar.gz.

File metadata

  • Download URL: tracknado-0.2.3.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for tracknado-0.2.3.tar.gz
Algorithm Hash digest
SHA256 a7a1e25b54f41c1b5b18fbe1a2fab626e00cd4da4f747f901b58b4f78d4c2651
MD5 7e6967357c71606de07afc25e942a9c0
BLAKE2b-256 cdd2566072258b08044b7396253f14e4173e49599f424ece2b0ecc81bdf6f431

See more details on using hashes here.

File details

Details for the file tracknado-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: tracknado-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for tracknado-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f89f05ec64c8135bd655016452225ed21d71bd3d6fa86adca89d0f8ade8c073f
MD5 afce1e1c87d742db11de59f43ede0446
BLAKE2b-256 832611ca64f5b875d0dd10c8354e0d1ff87d85c12893696b099e9c0ca5879a65

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page