JBrowse1TextSearchAdapter

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the legacy-jbrowse plugin. View source.

Example usage#

An entry in aggregateTextSearchAdapters, pointing at the names/ directory JBrowse 1's generate-names.pl wrote — so an existing instance's search index is reused rather than rebuilt with jbrowse text-index:

{
  type: 'TextSearchAdapter',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'JBrowse1TextSearchAdapter',
    textSearchAdapterId: 'jbrowse1-names',
    namesIndexLocation: { uri: 'https://example.com/jbrowse1/data/names/' },
    assemblyNames: ['hg19'],
  },
}

See the Config slots section below for all available configuration fields.

Overview#

note: metadata about tracks and assemblies covered by text search adapter

JBrowse1TextSearchAdapter - Identifier#

Every JBrowse1TextSearchAdapter has a unique textSearchAdapterId, a required top-level field that identifies it (not one of the config slots below).

Config slots#

These slots go inside the track's adapter: "adapter": { "type": "JBrowse1TextSearchAdapter", ... }. This adapter has no uri shorthand — give it the location slots below. 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.

Related links#

• Guide: Supported file types
• Guide: Text search adapters
• Guide: Text searching