Skip to main content

ChainAdapter

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

Example usage

{
  type: 'SyntenyTrack',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg19', 'hg38'],
  adapter: {
    type: 'ChainAdapter',
    uri: 'https://example.com/aln.chain',
    queryAssembly: 'hg19',
    targetAssembly: 'hg38',
  },
}

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

used to load UCSC chain alignment files (query and target assembly required)

Config slots

These slots go inside the track's adapter: "adapter": { "type": "ChainAdapter", ... }. It also accepts the shorthand keys uri, baseUri in place of writing a location slot out. 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
chainLocation
fileLocation = { uri: '/path/to/file.chain', locationType: 'UriLocation' }		location of the UCSC chain file, as used by liftOver and produced by axtChain. May be gzipped; the whole file is read into memory.
assemblyNames
stringArray = []		Array of assembly names to use for this file. The query assembly name is the first value in the array, target assembly name is the second
targetAssembly
string = ''		Alternative to assemblyNames: the target assembly name
queryAssembly
string = ''		Alternative to assemblyNames: the query assembly name