API reference#

This page gives an overview of all public precellar objects, functions and methods.

Core Classes#

W5Z(self, /, filename[, mode])

W5Z object is a zfp compressed basepair resolution data format for representing genome-wide * coverage data, such as ChIP-seq, ATAC-seq, and other genomic signals.

GenomeDataLoader(self, /, location, *[, ...])

A dataloader for genomic data, allowing for efficient retrieval of genomic sequences and their associated values.

GenomeDataLoaderMap(self, /, loaders, *[, ...])

A dictionary-like class for loading multiple genomic datasets simultaneously.

CatGenomeDataLoader(self, /, loaders, *[, ...])

This class combines multiple GenomeDataLoaderMap instances into a single loader.

GenomeDataBuilder(self, /, location, ...[, ...])

Represents a builder for genomic data, allowing for the creation and management of genomic datasets.

Utilities#

utils.Transcript

Position is 0-based.

utils.bw_to_w5z(input, output, *[, zfp, ...])

Formats the sum of two numbers as string.

utils.bam_cov(input, output, *[, output2, ...])

utils.read_transcripts(gff_file, *[, ...])