R: Get information of the circular plot

circos.info {circlize} | R Documentation

## Get information of the circular plot

### Description

Get information of the circular plot

### Usage

    circos.info(sector.index = NULL, track.index = NULL, plot = FALSE)

### Arguments

`sector.index` | Which sectors you want to look at? It can be a vector.
`track.index` | Which tracks you want to look at? It can be a vector.
`plot` | Whether to add information on the plot

### Details

It tells you the basic parameters for sectors/tracks/cells. If both `sector.index` and `track.index` are set to `NULL`, the function would print index for all sectors and all tracks. If `sector.index` and/or `track.index` are set, the function would print `xlim`, `ylim`, `cell.xlim`, `cell.ylim`, `xplot`, `yplot`, `track.margin` and `cell.padding` for every cell in specified sectors and tracks. Also, the function will print index of your current sector and current track.

If `plot` is set to `TRUE`, the function will plot the index of the sector and the track for each cell on the figure.

### References

Gu, Z. (2014) circlize implements and enhances circular visualization in R. Bioinformatics.

### Examples

    factors = letters[1:4]
    circos.initialize(factors, xlim = c(0, 1))
    circos.trackPlotRegion(ylim = c(0, 1))
    circos.trackPlotRegion(ylim = c(0, 1))
    circos.info(sector.index = "a", track.index = 1)
    circos.info(sector.index = "a", track.index = 1:2)
    circos.info(sector.index = c("a", "b"), track.index = 1)
    circos.info(sector.index = "a")
    circos.info(track.index = 1)
    circos.info()
    circos.info(plot = TRUE)
    circos.clear()

[Package circlize version 0.4.5 Index]