Skip to main content

BedAdapter

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

Example usage

{
  type: 'FeatureTrack',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'BedAdapter',
    uri: 'https://example.com/features.bed',
  },
}

features.bed infers BedAdapter and FeatureTrack on its own, and name defaults to the file name. In a config declaring one assembly, assemblyNames comes from there too — see the shortest track.

{
  trackId: 'my_track',
  uri: 'https://example.com/features.bed',
  assemblyNames: ['hg38'],
}

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

Gotcha

Named BED columns past name/score/strand (itemRgb, thickStart, ...) are only guaranteed for BED12 or a track with an autoSql/columnNames. For a BED7-BED11 file JBrowse cannot know what the extra columns mean, so it exposes them generically as field6, field7, ... and a jexl callback reading feature.itemRgb gets undefined. Set columnNames to refer to them by name.

used to load plain-text BED files. Loads the whole file into memory, so prefer the BedTabixAdapter for large files.

Config slots

These slots go inside the track's adapter: "adapter": { "type": "BedAdapter", ... }. 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
bedLocation
fileLocation = { uri: '/path/to/my.bed.gz', locationType: 'UriLocation' }		path to bed file, also allows gzipped bed
columnNames
stringArray = []		List of column names. A column named like a standard BED column is parsed as that column's type (chromStart numeric, blockSizes a numeric list); any other column is text
scoreColumn
string = ''		The column to use as a "score" attribute
autoSql
string = ''		The autoSql definition for the data fields in the file
colRef
number = 0		The column to use as a "refName" attribute
colStart
number = 1		The column to use as a "start" attribute
colEnd
number = 2		The column to use as a "end" attribute
disableGeneHeuristic
boolean = false		Disable the heuristic that auto-detects BED12 features as gene/transcript structures. Useful for files that have BED12-like structure but are not genes (e.g. tandem duplications)