bioMatrixLegend: Plot Legend on caOmicsV bioMatrix Layout
In hzhanghenry/caOmicsV: Visualization of multi-dimentional cancer genomics data

Description Usage Arguments Details Value Author(s) Examples

Draw legend including of heatmap color scale and data categories. Graphic device must be initialized first.

1 2	bioMatrixLegend(heatmapNames=NULL, categoryNames=NULL, binaryNames=NULL, heatmapMin=-3, heatmapMax=3, colorType="BlueWhiteRed")

`heatmapNames`	character vector of length 2, name(s) of dataset for heatmap, e.g., "RNASeq" and/or "miRNASeq"
`categoryNames`	character vector of length 2 or more, names of categories, e.g., "Methylation High", "Methylation Low", ...
`binaryNames`	character vector of length 2 , names of binary data, e.g., "DNA Amplification" and "DNA Deletion".
`heatmapMin`	numeric, minimum values of heatmap plot data, default -3 (z-scores)
`heatmapMax`	numeric, maximum values of heatmap plot data, default 3 (z-scores)
`colorType`	characte veector, one of "BlueWhiteRed", "GreenWhiteRed", "GreenYellowRed", "GreenBlackRed" , or "YellowToRed"

This function will plot legend on the bottom of matrix layout if any argument is defined. The order of legend items (from left to right) is heatmap color scale followed by colored boxes for category data legend then colored points for binary data legend.

None

Henry Zhang

    data(biomatrixPlotDemoData)
    plotBioMatrix(biomatrixPlotDemoData, summaryType="text")
    bioMatrixLegend(heatmapNames=c("RNASeq", "miRNASeq"), 
        categoryNames=c("Methyl H", "Methyl L"), 
        binaryNames=c("CN LOSS", "CN Gain"),   
        colorType="BlueWhiteRed")