RCircos (version 1.2.2)

RCircos.Plot.Heatmap.Color.Scale: Plot A Color Scale for Heatmap

Description

Plot a color scale showing the color ranges of heatmap. One or more tracks should be defined for plots in outside of chromosome ideogram.

Usage

RCircos.Plot.Heatmap.Color.Scale(max.value=NULL, min.value=NULL,
        color.type="BlueWhiteRed", scale.location=1, 
        scale.width=0, scale.height=0)

Arguments

max.value

Numeric, maximum value of heatmap scale

min.value

Numeric, minimum value of heatmap scale

color.type

Character vector for color specification, either "BlueWhiteRed", "GreenWhiteRed", "GreenYellowRed","GreenBlackRed", "YellowToRed", or "BlackOnly". Default is "BlueWhiteRed".

scale.location

Non negative integer representing color scale location, 1~4 for bottom, left, top, and right.

scale.width

Non-negative numeric, width of color scale. if not defined, 1/2 of x axis will be used

scale.height

Non-negative numeric, height of color scale. if not defined, 1/10 of scaleWidth axis will be used

Examples

# NOT RUN {
plot.new()
plot.window(c(-5, 5), c(-5, 5))
RCircos.Plot.Heatmap.Color.Scale(max.value=3, min.value=-3,
    scaleLocation=1, colorType="BlueWhiteRed", 
    scaleWidth=0, scaleHeight=0)
# }