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.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

tracknado-0.2-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tracknado-0.2.tar.gz
  • Upload date:
  • Size: 29.9 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.tar.gz
Algorithm Hash digest
SHA256 199a36391cd901bdd3e04685448beca7dcc2dbfd3388a4689f1038691d23c897
MD5 7b0c7d8092552cc87522abad1fb994c5
BLAKE2b-256 d324322914471096b64b4971699e746cd40b724f853a6521a4e588944841fb8c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tracknado-0.2-py3-none-any.whl
  • Upload date:
  • Size: 31.7 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-py3-none-any.whl
Algorithm Hash digest
SHA256 83f0d56f19188cdb11d06b3bc46b5b8e40dc08e353f42c50dcaa65850ca78d6a
MD5 05e4f5a5b2488b64871519a59a4b2eb1
BLAKE2b-256 223fc50de16cc66b54f8ce6c6de773807777588063472111b4a1afb79c5f055d

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