PileupMismatchesOpacity
Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the alignments plugin. View source.
The pileup's mismatches.encoding.opacity. Unset, each mismatched base
fades by its Phred base quality through a linear scale, by default from 0.1
at Q5 to opaque from Q20 up. A number is a constant opacity for every
mismatch, written to value: 1 draws them all opaque. A string is the
field. A base whose read carries no qualities draws opaque.
Example usage
{
type: 'LinearAlignmentsDisplay',
pileup: { mismatches: { encoding: { opacity: 1 } } },
}{
type: 'LinearAlignmentsDisplay',
pileup: {
mismatches: {
encoding: {
opacity: {
field: 'baseQuality',
scale: { domainMin: 0, domainMax: 30, range: [0.2, 1] },
},
},
},
},
}Config slots
A setting written to it replaces it whole: a member left out returns to its default. 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 |
|---|---|
valuemaybeNumber |
Every mismatch's opacity, 0 to 1, while no field fades them; a base whose read carries no qualities still draws opaque. Writing opacity: 1 lands here. |
fieldmaybeStringEnum (baseQuality) |
baseQuality fades each mismatched base by its Phred quality; unset follows value, and with neither written fades by baseQuality |
| scale PileupMismatchesOpacityScale sub-schema |
How a base quality maps to an opacity. |
scale.domainMinnumber = 5 |
the Phred quality that takes the first opacity in range |
scale.domainMaxnumber = 20 |
the Phred quality that takes the last opacity in range |
scale.rangestringArray = QUALITY_OPACITY_RANGE.map(String) |
the opacities, 0 to 1, at the two ends of the domain |
scale.clampboolean = true |
a quality past the domain takes the nearer end of the range; off, the line runs on until the base is fully opaque or gone |