Skip to main content

TwoBitAdapter

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​

TwoBitAdapter - Pre-processor / simplified config​

preprocessor to allow minimal config (note that adding chromSizes improves speed, otherwise has to read a lot of the twobit file to calculate chromosome names and sizes):

{
  "type": "TwoBitAdapter",
  "uri": "yourfile.2bit"
  "chromSizes":"yourfile.chrom.sizes"
}

TwoBitAdapter - Slots​

slot: twoBitLocation​

twoBitLocation: {
      type: 'fileLocation',
      defaultValue: {
        uri: '/path/to/my.2bit',
        locationType: 'UriLocation',
      },
    }

slot: chromSizesLocation​

chromSizesLocation: {
      type: 'fileLocation',
      defaultValue: {
        uri: '/path/to/default.chrom.sizes',
        locationType: 'UriLocation',
      },
      description:
        'An optional chrom.sizes file can be supplied to speed up loading since parsing the twobit file can take time',
    }