BigMafAdapter
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the maf plugin. View source.
Reads a UCSC bigMaf file, a BigBed that holds a MAF multiple alignment block in each record.
Example usage
samples names the rows in the order they are drawn, and has to match the
species keys in the file — a bigMaf has the alignment but no display
order, so an omitted or misspelled name shows as a missing row rather than an
error:
{
type: 'MafTrack',
trackId: 'my_track',
name: 'My track',
assemblyNames: ['hg38'],
adapter: {
type: 'BigMafAdapter',
uri: 'https://example.com/multiz.bb',
samples: ['hg38', 'panTro6', 'rheMac10', 'mm39'],
},
}Related links
- Track: MafTrack
- Display: LinearMafDisplay
- Display: LinearMarkDisplay
- Config guide: MAF track
- Config guide: Supported file types
Config slots
Adapter slots go inside the track's adapter: "adapter": { "type": "BigMafAdapter", ... }. 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.
| Slot | Description |
|---|---|
bigBedLocationfileLocation = { uri: '/path/to/my.bb', locationType: 'UriLocation' } |
location of the bigMaf file — a BigBed whose extra field holds the MAF alignment block, as built by UCSC's mafToBigMaf followed by bedToBigBed -type=bed3+1 -as=bigMaf.as -tab. |
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 (typically a BigBedAdapter over UCSC bigMafSummary.bb, which is published alongside the bigMaf) used for cheap zoom-out rendering; leave it unset to disable |
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 |