MafTabixAdapter
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the maf plugin. View source.
Multiple alignment format converted to a bgzipped, tabix-indexed BED. The
nhLocation newick tree orders and labels the species rows; refAssemblyName
names the MAF's reference species when it differs from the assembly name.
Example usage
{
type: 'MafTrack',
trackId: 'my_track',
name: 'My track',
assemblyNames: ['hg38'],
adapter: {
type: 'MafTabixAdapter',
bedGzLocation: { uri: 'https://example.com/multiz.bed.gz' },
index: { location: { uri: 'https://example.com/multiz.bed.gz.tbi' } },
nhLocation: { uri: 'https://example.com/multiz.nh' },
},
}Related links
- Track: MafTrack
- Display: LinearMafDisplay
- Display: LinearMarkDisplay
- Tutorial: Pangenome (Minigraph-Cactus)
- Tutorial: Pangenome (pggb)
- Config guide: MAF track
- Config guide: Supported file types
Config slots
Adapter slots go inside the track's adapter: "adapter": { "type": "MafTabixAdapter", ... }. It also accepts the shorthand keys uri, baseUri, csi, 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.
| Slot | Description |
|---|---|
bedGzLocationfileLocation = { uri: '/path/to/my.bed.gz', locationType: 'UriLocation' } |
location of the bgzip-compressed BED that maf2bed writes from a MAF: one line per alignment block, with every species' aligned bases packed into the last column. |
refAssemblyNamestring = '' |
name of the MAF's reference species, spelled as it appears in the file's s lines (the hg38 of hg38.chr1). Set it when that differs from the JBrowse assembly name; left empty, the reference row is looked up by the queried assembly's name and falls back to the block's first species. |
| index TabixIndex |
The tabix index location and its kind. The uri shorthand derives both, so a config using it states neither. |
samplesfrozen = [] |
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 |
nhLocationmaybeFileLocation |
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 |
summaryAdaptermaybeFrozen |
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. A tabix MAF holds every species' bases on one line, so a wide read downloads the whole alignment and the byte gate blocks it; without this slot the track has no zoom-out path |
samplesTsvLocationmaybeFileLocation |
optional tab-separated table of per-sample metadata. It needs a header row, whose first cell is not read, 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 variant and wiggle displays, and a mark display over a MultiWiggle, group, sort, color and tooltip rows by, and a blank cell is no value; label and color name and color the row. A VCF's table ignores a sampleName, HP or sole column, with a warning, since the variant display writes those fields on its haplotype rows. A MAF adapter reads only 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, with a warning naming the rest, 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 |
framesAdaptermaybeFrozen |
optional sub-adapter (typically a BigBedAdapter over a UCSC multiz<N>wayFrames.bb) supplying each species' CDS reading frames for the frames strip, the codon view and the codon conservation band; leave it unset to disable |