tabix-reader

1.0.1 • Public • Published

Tabix Reader

Purpose

Tabix is a popular tool that enables fast access to compressed data. A stated goal of the tool is to "enable genome viewers to support huge data files and remote custom tracks over networks".

This library allows web applications to use the power of tabix directly, without the need for a server to mediate reading or decompressing of data. It is extracted from BioDalliance to support standalone usage and modern modular build tools.

Usage

Currently, the API is a mix of Promises (to create the reader) and callbacks (to fetch data). In the future this may be refactored for consistency.

Two modes are supported: urlReader (from remote URLs that support HTTP Range requests) and blobReader (from a local file). In both cases, the target must have been processed via tabix first, and the path to the index file must be explicitly specified.

If you are using the pre-built dist/main.js version, symbols can be accessed under the global window.tabix variable.

tabix.urlReader(url, indexUrl).then((reader) => {
    var callback = (rows, error) => {
        console.log(rows);
    };
    reader.fetch("1", 546375, 1046375, callback); 
});

Or they can be imported via ES6 modules and then used as normal:

import { blobReader } from 'tabix-reader';

Credits

This code is adapted from the BioDalliance genome viewer with minor changes, making its data access capabilities easily available to other libraries.

Readme

Keywords

none

Package Sidebar

Install

npm i tabix-reader

Weekly Downloads

39

Version

1.0.1

License

BSD

Unpacked Size

287 kB

Total Files

14

Last publish

Collaborators

  • abought