circosLegend {MetCirc} | R Documentation

## Plot a legend for circos plot

### Description

`circosLegend` plots a legend for circos plot using group names.

### Usage

    circosLegend(groupname, highlight = TRUE, colour = NULL, cex = 1)

### Arguments

`groupname` | `character` vector containing "group" and "name" to display, that is a unique identifier of the features, "group" and "name" have to be separated by `"_"` where "group" is the first and "name" is the last element
`highlight` | `logical`, should colours be adjusted to highlight settings?
`colour` | `NULL` or `character`, colour defines the colours which are used for plotting, if `NULL` default colours are used
`cex` | `numeric`, parameter that controls size of the legend in the plot

### Details

Internal use in `shinyCircos` or outside of `shinyCircos` to reproduce figures.

### Value

The function will open a new plot and display colours together with labels.

### Author(s)

Thomas Naake, thomasnaake@googlemail.com

### Examples

     ## load binnedMSP
     data("binnedMSP", package = "MetCirc")
     ## use only a selection
     binnedMSP <- binnedMSP[c(1:20, 29:48, 113:132, 240:259),]
     similarityMat <- createSimilarityMatrix(binnedMSP)
     groupname <- rownames(similarityMat)
     ## plot legend
     circosLegend(groupname, highlight = TRUE, colour = NULL, cex = 1)

[Package MetCirc version 1.10.0 Index]