Skip to main content

BgzipTaffyAdapter

Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the maf plugin. View source.

Reads a bgzip-compressed TAF (Taffy) multiple alignment file through its .tai index.

Example usage

The uri shorthand auto-resolves the sibling .tai index; nhUri names the Newick tree:

{
  type: 'MafTrack',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'BgzipTaffyAdapter',
    uri: 'https://example.com/aln.taf.gz',
  },
}

Config slots

Adapter slots go inside the track's adapter: "adapter": { "type": "BgzipTaffyAdapter", ... }. It also accepts the shorthand keys uri, baseUri, nhUri in place of writing a location slot out. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
tafGzLocation
fileLocation = { uri: '/path/to/my.taf.gz', locationType: 'UriLocation' }		bgzip taffy file
taiLocation
fileLocation = { uri: '/path/to/my.taf.gz.tai', locationType: 'UriLocation' }		taffy index
samples
frozen = []		string[] or {id:string,label:string,color?:string,assemblyName?:string,assemblyConfigLocation?:UriLocation}[]; assemblyName makes rows for that sample navigable to the genome named by assemblyName, and assemblyConfigLocation gives the location to load that assembly from when the session lacks it
nhLocation
maybeFileLocation		newick tree naming and ordering the species rows; its leaf names are the sample ids, and any samples entries supply label/color overrides matched by id
summaryAdapter
maybeFrozen		optional swappable sub-adapter (a BedTabixAdapter over a maf2bed --summary BED, or a BigBedAdapter over UCSC bigMafSummary.bb) used for cheap zoom-out rendering; leave it unset to disable. The zoom-out tier works on the same terms as BgzipMafAdapter's: the .tai makes a read cost the span on screen rather than the number of blocks it covers, but cost is span × depth, so a deep alignment stays expensive. Measured against HPRC's published v2.0 TAF index, 464 haplotypes cost about 2 compressed bytes per bp, flat from 100 kb up — a ninth of the same alignment's MAF, and still 354 MB for chr6 whole. TAF moves the ceiling out by about 10x; it does not remove it
samplesTsvLocation
maybeFileLocation		optional tab-separated table of per-sample metadata. It needs a header row, and its first column is the sample name exactly as the adapter spells it: a VCF sample, a MultiWiggle subtrack's name, a MAF species id. Every other column (population, tissue, ...) becomes an attribute of that sample, which the multi-row displays group, sort, color and tooltip rows by; a MAF adapter reads the label, color and assemblyName columns onto its species rows, over its samples entries. The table also narrows the adapter's samples to the ones it lists, and a table naming none of them is an error. An adapter that names no samples (a MAF track discovering its species from the file) takes the table's rows as its samples
framesAdapter
maybeFrozen		optional sub-adapter (typically a BigBedAdapter over a UCSC multizwayFrames.bb) supplying each species' CDS reading frames for the frames strip, the codon view and the codon conservation band; leave it unset to disable

Retired keys

An older config may still write these. Each loads without an error, and jbrowse validate reports it as stale.

KeyOn load
annotationAdaptermoved into a current slot