trix-js

Read UCSC Trix indexes in pure JavaScript

Install

npm install @gmod/trix

Usage

import Trix from '@gmod/trix'
import { RemoteFile } from 'generic-filehandle2'

// generic-filehandle2 also has LocalFile for files on disk
const trix = new Trix(
  new RemoteFile('https://jbrowse.org/genomes/GRCh38/trix/hg38.ixx'),
  new RemoteFile('https://jbrowse.org/genomes/GRCh38/trix/hg38.ix'),
)

const results = await trix.search('oca')
// => [[term, record], ...]

API

new Trix(ixxFile, ixFile, maxResults?)

• ixxFile - filehandle for the .ixx file
• ixFile - filehandle for the .ix file
• maxResults - most results a search returns, default 20. Also settable afterwards as trix.maxResults

trix.search(searchString, opts?)

Prefix-searches the index and resolves to [term, record][], where term is the indexed word that matched and record is the key it points to. Records are deduplicated, so two terms hitting the same record yield one result.

• searchString - the query; only its first whitespace-separated word is used
• opts.signal - an AbortSignal to cancel the underlying reads

Reading over HTTP

A search fetches the .ixx once, then reads the .ix in 64 KiB pieces from wherever the checkpoint lands, so the reads are small and land at scattered offsets in much the larger of the two files. A typeahead makes one search per keystroke, and consecutive keystrokes land close together: typing spd_00 into this repo's 1.7 MB test index is six searches and six 64 KiB reads, but only three distinct offsets. Putting @gmod/range-cache-filehandle under both filehandles serves those six reads out of three 256 KiB chunks, and a prefix the user backspaces to costs nothing:

import { RemoteFileWithRangeCache } from '@gmod/range-cache-filehandle'

const trix = new Trix(
  new RemoteFileWithRangeCache(`${url}.ixx`),
  new RemoteFileWithRangeCache(`${url}.ix`),
)

Reference

See the UCSC trix documentation for the concepts, and ixixx-js for a JavaScript implementation of the ixIxx command that builds these indexes.

See CONTRIBUTING.md for development and release steps.