LDTrackDisplay
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the variants plugin. View source.
Linkage disequilibrium heatmap read from an LDTrack's pre-computed file —
PLINK --r2 output and the formats that follow it. JBrowse does not compute
LD from genotypes; run plink (or an equivalent) and point this at the result.
Example usage
{
type: 'LDTrack',
trackId: 'ld',
name: 'Linkage disequilibrium',
assemblyNames: ['hg38'],
adapter: {
type: 'PlinkLDTabixAdapter',
uri: 'https://example.com/plink.ld.gz',
},
displays: [
{
type: 'LDTrackDisplay',
displayId: 'ld-LDTrackDisplay',
encoding: { color: { field: 'dprime' } },
legend: { show: true },
},
],
}Overview
LDTrackDisplay - Identifier
Every LDTrackDisplay has a unique displayId, a required top-level field that identifies it (not one of the config slots below).
Related links
- Adapter: PlinkLDAdapter
- Adapter: PlinkLDTabixAdapter
- State model: runtime API
- Config guide: Tracks
- Developer guide: Custom track and display types
Color channels
| Setting | Page | scale.type |
Preset fields |
|---|---|---|---|
encoding.color |
LDColor | linear, threshold | r2, dprime |
Config slots
Display slots go on a display entry: "displays": [{ "type": "LDTrackDisplay", ... }], or in the track's displayDefaults when this is its default display. 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 |
|---|---|
fetchSizeLimitnumber = 20000000 |
A pair costs about 11 compressed bytes, so 20 MB is some 1.8 million pairs, and the 790k pairs of a 1,258-variant triangle fit with room. The estimate is read from the tabix index, before any pair downloads. advanced |
| connectors LDConnectors sub-schema |
The band above the triangle holding the connector lines that tie each of its columns to a genomic position, and the variant names when they show: show and height, taken from the display's height. Off, neither the lines nor the names draw. |
connectors.showboolean = true |
draw the connector lines and the names above the triangle |
connectors.heightnumber = 100 |
height of the connector band in pixels, taken from the triangle's; its seam drag writes it |
| encoding LDEncoding |
The cells' channels: encoding.color, the statistic the cells show, field r2 or dprime, and the linear ramp it paints through over the statistic's 0 to 1. |
| legend HiddenLegend |
The color ramp's key, off until asked for. |
| labels LDLabels sub-schema |
The text drawn at each variant's tick mark. |
| labels.name LDNameLabel sub-schema |
Each variant's name, above its tick mark. No field: an LD SNP carries only the id its file names, its position and its MAF, so the id is the one text there is to draw. |
labels.name.showboolean = false |
draw each variant name above its tick mark advanced |
variantLayoutstringEnum (genomic, columns) = 'columns' |
'columns' draws every SNP one uniform square wide; 'genomic' sizes the cells by the genomic distance between SNPs. LinearVariantDisplay takes the same slot for the same choice.advanced |
heightnumber = 400 |
default height of the display, the band above the triangle included |
heightModestringEnum (fixed, fit) = 'fixed' |
fixed draws square cells at the triangle's natural half-width height; fit squashes it to fill the display height |
forceLoadboolean = false |
Declarative equivalent of the "Force load" button on the "too much data" banner: when true the display always renders, however large the region or dense the features. Off by default (the gate guards against huge downloads). Set it on a view with no user interaction, such as an embedded or notebook view or a screenshot, where the region is known and should draw without a click. advanced |
Retired keys
An older config may still write these. Each loads without an error, and jbrowse validate reports it as stale.
| Key | On load |
|---|---|
maxFeatureScreenDensity |
ignored |
maxDisplayedBpPerPx |
ignored |
mouseover |
ignored |
jexlFilters |
moved into a current slot |
ldMetric |
moved into a current slot |
showLegend |
moved into a current slot |
showVerticalGuides |
ignored |
tickHeight |
ignored |
lineZoneHeight |
moved into a current slot |
fitToHeight |
moved into a current slot |
useGenomicPositions |
moved into a current slot |
maxHeight |
ignored |
colorScheme |
ignored |
signedLD |
ignored |
showLDTriangle |
ignored |
showRecombination |
ignored |
recombinationZoneHeight |
ignored |
minorAlleleFrequencyFilter |
ignored |
lengthCutoffFilter |
ignored |
hweFilterThreshold |
ignored |
callRateFilter |
ignored |
showLabels |
moved into a current slot |