UCSCTrackHubConnection
Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the data-management plugin. View source.
Adds the tracks a UCSC track hub's hub.txt declares for each matching
assembly to the session.
Example usage
An entry in the config's connections. The hub's hub.txt is read on
connect and every track it declares for a matching assembly is added to the
session — nothing is written into your config, so the hub stays the source of
truth. assemblyNames limits which of the hub's genomes are used.
{
type: 'UCSCTrackHubConnection',
connectionId: 'ucsc_hub_example',
name: 'My track hub',
assemblyNames: ['hg38'],
hubTxtLocation: { uri: 'https://example.com/hub.txt' },
}Related links
- State model: runtime API
- Base config: BaseConnection
- Config guide: Connections
Config slots
Connection slots are top-level fields of the connection's entry in connections. 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.
| Slot | Description |
|---|---|
hubTxtLocationfileLocation = | location of the hub file (usually called hub.txt) |
assemblyNamesstringArray = [] | optional list of genomes to import from this track hub, if empty all genomes will be imported |
| Inherited from BaseConnection | 1 slot |
namestring = 'nameOfConnection' | a unique name for this connection |