Skip to main content

ReadsPileup

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

LinearAlignmentsDisplay's pileup: the Pileup band with the per-base layer over the reads, bases, which a synteny block, having no qualities or basecaller tags, goes without.

Example usage

{
  type: 'LinearAlignmentsDisplay',
  pileup: { bases: { show: true, encoding: { color: 'modifications' } } },
}

Config slots

A setting written to it names members one by one: a member left out stays as it is, and null resets one. 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
bases
PileupBases		The per-base layer: show and encoding.color.
Inherited from Pileup7 slots
show
boolean = true		draw the pileup band
mark
PileupMark		The bar each read draws as: height.
maxLayoutHeight
number = 6000		the tallest the pileup's layout grows in pixels; reads past it are not stacked, and coverage still counts them. Not the display's growMaxHeight, which caps how tall the track grows
advanced
mismatches
PileupMismatches		How reads differ from the reference: show, and encoding.opacity, the fade by base quality.
softClips
PileupSoftClips		The soft-clipped ends of each read: show.
connectors
PileupConnectors		Lines over the pileup joining each read to its mate or split segment: show.
fadeLowFrequency
boolean = true		fade each sub-pixel mismatch, insertion, deletion and clip mark by the share of reads at its position that have it: a mark every read has stays opaque, and one under the depth-dependent noise threshold drops to the sub-pixel floor and, past one base per pixel, takes no clicks. Off draws them all at full opacity. The coverage band is not faded (see runCoveragePipeline)
advanced