Unit tests

GenomicRanges

GenomicRanges is a Python container class designed to represent genomic locations and support genomic analysis. It is similar to Bioconductor's GenomicRanges.

Install

Package is published to PyPI

pip install genomicranges

Usage

The package provides several ways to represent genomic annotations and intervals.

Initialize a `GenomicRanges` object

From UCSC or GTF file

You can easily access UCSC genomes or load a genome annotation from a GTF file using the following methods:

import genomicranges

gr = genomicranges.from_gtf(<PATH TO GTF>)
# OR
gr = genomicranges.from_ucsc(genome="hg19")

Pandas DataFrame

A common representation in Python is a pandas DataFrame for all tabular datasets. You can convert a DataFrame into a GenomicRanges object. Please note that intervals are inclusive on both ends, and your DataFrame must contain columns seqnames, starts, and ends to represent genomic coordinates.

Here's an example:

import genomicranges
import pandas as pd

df = pd.DataFrame(
    {
        "seqnames": ["chr1", "chr2", "chr1", "chr3", "chr2"],
        "starts": [101, 102, 103, 104, 109],
        "ends": [112, 103, 128, 134, 111],
        "strand": ["*", "-", "*", "+", "-"],
        "score": range(0, 5),
        "GC": [random() for _ in range(5)],
    }
)

gr = genomicranges.from_pandas(df)

Interval Operations

GenomicRanges currently supports most commonly used interval based operations.

subject = genomicranges.from_ucsc(genome="hg38")

query = genomicranges.from_pandas(
    pd.DataFrame(
        {
            "seqnames": ["chr1", "chr2", "chr3"],
            "starts": [100, 115, 119],
            "ends": [103, 116, 120],
        }
    )
)

hits = subject.nearest(query)
print(hits)

For more usage examples, check out the documentation.

Note

This project has been set up using PyScaffold 4.1.1. For details and usage information on PyScaffold see https://pyscaffold.org/.

Release files for genomicranges 0.3.5

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

Source distribution (sdist)

Source distribution for genomicranges 0.3.5
File	Size	Uploaded
GenomicRanges-0.3.5.tar.gz	54.8 kB	Sep 20, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for genomicranges 0.3.5
File	Interpreter	ABI	Platform	Reset
GenomicRanges-0.3.5-py3-none-any.whl 34.6 kB Sep 20, 2023	Python 3	none	any	Details

Total release size: 89.4 kB

Release files / GenomicRanges-0.3.5.tar.gz

Download URL	GenomicRanges-0.3.5.tar.gz
Size	54.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`93cfd9a1a5a687863efe609ed6004d767beed96438cc068de15c08d55e699b5a`
BLAKE2b-256 checksum How to use checksums	`9810a1643817be988daece04fd21479b0b8651810d7a0c1468a047a3d84f7d31`
Upload date	Sep 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`

Release files / GenomicRanges-0.3.5-py3-none-any.whl

Download URL	GenomicRanges-0.3.5-py3-none-any.whl
Size	34.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4919111f40c2e2aa94a5de1983048632f7af770f924bf3eff95dc31ee7800930`
BLAKE2b-256 checksum How to use checksums	`d227d5b38452f18e61e3253e0ce80cdfd5783bf8b9de7ecc86d6cadfe754ef4b`
Upload date	Sep 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`