Skip to main content

# ucsc_snapshots documentation

Version: 0.1.8

## Summary

ucsc_snapshots retrieves pictures from UCSC Genome Browser based on coordinates specified from BED3+ file and a session ID (hgsid).

UCSC Genome Browser should be set up with tracks prior to using the utility and saved as a session. This includes all track settings, sizes etc. Once these are setup, you can load the page source and identify the hgsid by searching for “hgsid=”

Supply the hgsid and a BED file. Images will be retrieved based on the coordinates in the BED file and saved to the directory as:

ucsc-snapshots-<hgsid>/chrom-start-end.pdf

ucsc-snapshots-<hgsid>/chrom-start-end.png

## Warnings

if you have many regions, you may need to run this overnight as thet UCSC limit s 1 request per 15 sec and 5000 requests per day.

Beware of multiple procs accessessing the same hgsid at the same time, they will affect each other’s strand settings

## Examples

The simplest case, just fetch images:

ucsc_snapshots BED3+ SESSIONID

Retrieve snapshots maintaining the display with 5’->3’ orientation using the strand field from the BED file:

ucsc_snapshots BED3+ SESSIONID –reverse-display

Add an annotation to the output directory (directory becomes ucsc-snapshots-<hgsid>-annotation/):

ucsc_snapshots BED3+ SESSIONID –dir-annotation celltype=MCF7

Output PNG files only (default is PDF and PNG):

ucsc_snapshots BED3+ SESSIONID –img-types png

## Installation

pip install ucsc_snapshots

Metadata

Release files for ucsc_snapshots 0.1.8

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

Source distribution (sdist)

Source distribution for ucsc_snapshots 0.1.8
File Size Uploaded Provenance Actions
ucsc_snapshots-0.1.8.tar.gz 1.9 kB Without provenance Details for ucsc_snapshots-0.1.8.tar.gz

Release files / ucsc_snapshots-0.1.8.tar.gz

Download URL ucsc_snapshots-0.1.8.tar.gz
Size 1.9 kB
Tags Source
SHA-256 checksum
How to use checksums
853024fd25eddeddf27191c3b500231c22364f1cdc7f57c8cdb7970d63d7c9de
BLAKE2b-256 checksum
How to use checksums
880b7c8638bb2f13ac3372d64a952ba2e0258d8a52906c195e902c4944f7cd9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for ucsc_snapshots 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.8 This release

1 release file No provenance

0.1.7

0.1.4

0.1.3

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