npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gmod/twobit

v4.0.1

Published

Read .2bit files in node or webpack

Downloads

2,093

Readme

@gmod/twobit

NPM version Coverage Status Build Status

Read .2bit sequence files using pure JavaScript, works in node or in the browser.

Install

$ npm install --save @gmod/twobit

Usage

const { TwoBitFile } = require('@gmod/twobit')
const t = new TwoBitFile({
  path: require.resolve('./data/foo.2bit'),
})

// get the first 10 bases of a sequence from the file.
// coordinates are UCSC standard 0-based half-open
const chr1Region = await t.getSequence('chr1', 0, 10)
// chr1Region is now a string of bases, 'ACTG...'

// get a whole sequence from the file
const chr1Bases = await t.getSequence('chr1')

// get object with all seq lengths as { seqName => length, ... }
const allSequenceSizes = await t.getSequenceSizes()

// get the size of a single sequence
const chr1Size = await t.getSequenceSize('chr1')

// get an array of all sequence names in the file
const seqNames = await t.getSequenceNames()

API

TwoBitFile

Table of Contents

constructor

Parameters
  • args object

    • args.filehandle Filehandle? node fs.promises-like filehandle for the .2bit file. Only needs to support filehandle.read(buffer, offset, length, position)
    • args.path string? filesystem path for the .2bit file to open

getSequenceNames

Returns any for an array of string sequence names that are found in the file

getSequenceSizes

Returns any object listing the lengths of all sequences like {seqName: length, ...}.note: this is a relatively slow operation especially if there are many refseqs in the file, if you can get this information from a different file e.g. a chrom.sizes file, it will be much faster

getSequenceSize

Parameters
  • seqName string name of the sequence

Returns any sequence length, or undefined if it is not in the file

getSequence

Parameters
  • seqName string name of the sequence you want
  • regionStart optional 0-based half-open start of the sequence region to fetch. (optional, default 0)
  • regionEnd optional 0-based half-open end of the sequence region to fetch. defaults to end of the sequence (optional, default Number.POSITIVE_INFINITY)

Returns any for a string of sequence bases

Academic Use

This package was written with funding from the NHGRI as part of the JBrowse project. If you use it in an academic project that you publish, please cite the most recent JBrowse paper, which will be linked from jbrowse.org.

License

MIT © Robert Buels