circosLegend: Plot a legend for circos plot

In MetCirc: Navigating mass spectral similarity in high-resolution MS/MS metabolomics data

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, [e-mail]

Examples

data("spectra", package = "MetCirc")
similarityMat <- compare_Spectra(spectra_tissue[1:10], 
    fun = normalizeddotproduct, binSize = 0.01)
linkDf <- createLinkDf(similarityMatrix = similarityMat, 
    spectra = spectra_tissue[1:10], 
    condition = c("SPL", "LIM", "ANT", "STY"), lower = 0.5, upper = 1) 
## cut link data.frame (here: only display links between groups)
linkDf_cut <- cutLinkDf(linkDf, type = "inter")
groupname <- c(as.character(linkDf_cut[, "spectrum1"]), 
            as.character(linkDf_cut[, "spectrum2"]))
groupname <- unique(groupname)
## plot legend
circosLegend(groupname, highlight = TRUE, colour = NULL, cex = 1)

MetCirc documentation built on Nov. 8, 2020, 8:26 p.m.