Skip to main content

JBrowse1TextSearchAdapter

Auto-generated from the config schema in the source — 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: 'JBrowse1TextSearchAdapter',
  namesIndexLocation: { uri: 'https://example.com/jbrowse1/data/names/' },
  assemblyNames: ['hg19'],
}

Searches a names index written by JBrowse 1's generate-names.pl. The tracks and assemblyNames slots list the tracks and assemblies the index covers.

Config slots

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.

SlotDescription
namesIndexLocation
fileLocation = { uri: '/volvox/names', locationType: 'UriLocation' }		the location of the JBrowse1 names index data directory
tracks
stringArray = []		List of tracks covered by text search adapter
assemblyNames
stringArray = []		List of assemblies covered by text search adapter