add_ideogram_track: Add ideogram track

Description Usage Arguments Details Value Author(s) Examples

View source: R/track.R

Description

Add ideogram track

Usage

1
2
add_ideogram_track(cytoband = system.file("extdata", "cytoBand.txt",
    package = "circlize"), species = NULL, track = current_track() + 1)

Arguments

cytoband

Path of the cytoband file or a data frame that already contains cytoband data. Pass to read.cytoband.

species

Abbreviations of species. e.g. hg19 for human, mm10 for mouse. If this value is specified, the function will download cytoBand.txt.gz from UCSC ftp automatically. Pass to read.cytoband.

track

which track the ideogram is added in. By default it is the next track in the layout.

Details

A track which contains ideograms will be added to the plot.

The function tries to download cytoband file from UCSC ftp. If there is no cytoband file available for the species, there will be an error.

Value

No value is returned.

Author(s)

Zuguang Gu <[email protected]>

Examples

1
2
3
gtrellis_layout(n_track = 2, ncol = 3,
    track_height = unit.c(unit(1, "null"), unit(5, "mm")))
add_ideogram_track(track = 2)

gtrellis documentation built on Nov. 17, 2017, 1:09 p.m.