Giter VIP home page Giter VIP logo

bgzf-randreader's Introduction

Maven Central

Overview

bgzf-randreader is a BGZF reader supports random access relative to uncompressed data.

Suppose we have a BGZF file compressed from some text:

$ echo 'The quick brown fox jumps over the lazy dog' | bgzip > test.gz

We can random access any part of it via RandomAccessBgzFile without decompression:

RandomAccessBgzFile file = new RandomAccessBgzFile(new File("test.gz"));
try {
    byte[] b = new byte[5];
    file.seek(4);
    file.read(b);
    System.out.println(new String(b));  // outputs: quick
} finally {
    file.close();   // always close it, prevent memory leak
}

Maven dependencies

To use bgzf-randreader in Maven-based projects, use following dependency:

<dependency>
    <groupId>com.vivimice</groupId>
    <artifactId>bgzf-randreader</artifactId>
    <version>1.1.1</version>
</dependency>

About BGZF

BGZF is a GZip compatible compression format. It is a block compression implemented on top of the standard gzip file format.

BGZF file can be generated from existing gzip file or any uncompressed data by bgzip utility. Any gzip compatible utility (like gunzip, zcat, zgrep, GZIPInputStream, etc.) can decompress BGZF compressed file.

On debian/Ubuntu, bgzip utility is included in tabix package.

More about BGZF: http://samtools.github.io/hts-specs/SAMv1.pdf

bgzf-randreader's People

Contributors

swoven123 avatar vivimice avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

swoven123

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.