LinearMultiSampleVariantDisplay

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

Draws the genotypes in a multi-sample VariantTrack, one row per sample or per phased haplotype.

Example usage#

Minimal VariantTrack config selecting this display type. The displays array form is required here (rather than the object shorthand) because this is a non-default display type — see configuring displays:

{
  type: 'VariantTrack',
  trackId: 'cohort',
  name: 'Cohort variants',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'VcfTabixAdapter',
    uri: 'https://example.com/cohort.vcf.gz',
  },
  displays: [
    {
      type: 'LinearMultiSampleVariantDisplay',
    },
  ],
}

Preloading sample metadata: point the adapter's samplesTsvLocation at a TSV whose first column is the sample name and whose other columns are per-sample attributes (e.g. population), then rowColor one of those attributes to color the sidebar rows on load. referenceDrawingMode: 'skip' (the default) paints the background solid grey and draws only ALT alleles on top, which makes overlapping structural variants easier to see; 'draw' paints the reference alleles too. This is the 1000 Genomes "colored by population" demo config:

{
  type: 'VariantTrack',
  trackId: 'cohort',
  name: 'Cohort variants',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'VcfTabixAdapter',
    uri: 'https://example.com/cohort.vcf.gz',
    samplesTsvLocation: { uri: 'https://example.com/samples.tsv' },
  },
  displays: [
    {
      type: 'LinearMultiSampleVariantDisplay',
      height: 800,
      rowColor: 'population',
      referenceDrawingMode: 'skip',
    },
  ],
}

Phased haplotype rows, one per haplotype of each sample. rows arranges them by sample name, so the order below puts both of HG002's rows first:

{
  type: 'VariantTrack',
  trackId: 'cohort',
  name: 'Cohort variants',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'VcfTabixAdapter',
    uri: 'https://example.com/cohort.vcf.gz',
  },
  displays: [
    {
      type: 'LinearMultiSampleVariantDisplay',
      height: 400,
      unit: 'haplotype',
      rows: { sort: ['HG002'] },
    },
  ],
}

One equal-width column per variant, tied to the genome by connector lines, for reading a genotype pattern across variants too close together to separate at their positions:

{
  type: 'LinearMultiSampleVariantDisplay',
  variantLayout: 'columns',
}

Related links#

• Adapter: BedpeAdapter
• Adapter: SplitVcfTabixAdapter
• Adapter: StarFusionAdapter
• Adapter: VcfAdapter
• Adapter: VcfTabixAdapter
• State model: runtime API
• Base config: BaseLinearDisplay
• Tutorial: LD across an inversion (mosquitoes)
• Tutorial: Mutation cohort (TCGA)
• User guide: Multi-sample variant display
• Config guide: Grouping and lane order
• Config guide: Tracks
• Config guide: Variant track
• Developer guide: Custom track and display types

Config slots#

Display slots go on a display entry: "displays": [{ "type": "LinearMultiSampleVariantDisplay", ... }], 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.

Retired keys#

An older config may still write these. Each loads without an error, and jbrowse validate reports it as stale.