Skip to main content

BedTabixAdapter

Note: this document is automatically generated from configuration objects in our source code. See Config guide for more info

Also note: this document represents the config API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs

BedTabixAdapter - Slots

slot: bedGzLocation

bedGzLocation: {
type: 'fileLocation',
defaultValue: { uri: '/path/to/my.bed.gz', locationType: 'UriLocation' },
}

slot: index.indexType

indexType: {
model: types.enumeration('IndexType', ['TBI', 'CSI']),
type: 'stringEnum',
defaultValue: 'TBI',
}

slot: index.location

location: {
type: 'fileLocation',
defaultValue: {
uri: '/path/to/my.bed.gz.tbi',
locationType: 'UriLocation',
},
}

slot: columnNames

columnNames: {
type: 'stringArray',
description: 'List of column names',
defaultValue: [],
}

slot: scoreColumn

scoreColumn: {
type: 'string',
description: 'The column to use as a "score" attribute',
defaultValue: '',
}

slot: autoSql

autoSql: {
type: 'string',
description: 'The autoSql definition for the data fields in the file',
defaultValue: '',
}