text_index: Create configuration for a JBrowse 2 text index

In JBrowseR: An R Interface to the JBrowse 2 Genome Browser

Create configuration for a JBrowse 2 text index

Description

Creates the necessary configuration string for an adapter to a text index for gene name search in the browser.

Usage

text_index(ix_uri, ixx_uri, meta_uri, assembly)

Arguments

ix_uri	the URI for the ix file
ixx_uri	the URI for the ixx file
meta_uri	the URI for the JSON metadata file
assembly	the assembly associated with the text index

Details

Note: this function currently only supports aggregate indeces.

For more information on JBrowse 2 text indeces, visit: https://jbrowse.org/jb2/docs/config_guide/#text-searching

Value

a character vector with the JSON text index adapter.

Examples

text_index(
"https://jbrowse.org/genomes/hg19/trix/hg19.ix",
"https://jbrowse.org/genomes/hg19/trix/hg19.ixx",
"https://jbrowse.org/genomes/hg19/trix/meta.json",
"hg19"
)

JBrowseR documentation built on June 8, 2023, 6:41 a.m.