Skip to main content

SplitVcfTabixAdapter

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​

SplitVcfTabixAdapter - Slots​

slot: vcfGzLocationMap​

object like {chr1:{uri:'url to file'}}

vcfGzLocationMap: {
      type: 'frozen',
      defaultValue: {},
    }

slot: indexLocationMap​

object like {chr1:{uri:'url to index'}}

indexLocationMap: {
      type: 'frozen',
      defaultValue: {},
    }

slot: indexType​

indexType: {
      type: 'string',
      defaultValue: 'TBI',
    }

slot: samplesTsvLocation​

samplesTsvLocation: {
      type: 'fileLocation',
      defaultValue: {
        uri: '/path/to/samples.tsv',
        description:
          'tsv with header like "name\tpopulation\tetc" where the first column is required, and corresponds to the sample names in the VCF files',
        locationType: 'UriLocation',
      },
    }