ColorBar                package:GLAD                R Documentation

_C_a_l_i_b_r_a_t_i_o_n _b_a_r _f_o_r _c_o_l_o_r _i_m_a_g_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     This function produces a color image (color bar) which can be used
     for the legend to another color image obtained from the functions
     'image' or 'arrayPlot'.

_U_s_a_g_e:

     ColorBar(x, horizontal=TRUE, col=heat.colors(50), scale=1:length(x), k=10, ...)

_A_r_g_u_m_e_n_t_s:

       x: If "numeric", a vector containing the "z" values in the color
          image, i.e., the values which are represented in the color
          image. Otherwise, a "character" vector representing colors.

horizontal: If 'TRUE', the values of 'x' are represented as vertical
          color strips in the image, else, the values are represented
          as horizontal color strips.

     col: Vector of colors such as that generated by 'rainbow',
          'heat.colors', 'topo.colors', 'terrain.colors', or similar
          functions. In addition to these color palette functions, a
          new function  'myPalette' was defined to generate color
          palettes from user supplied low, middle, and high color
          values.

   scale: A "numeric" vector specifying the "z" values in the color
          image. This is used when the argument 'x' is a "character"
          vector representing color information.

       k: Object of class "numeric", for the number of labels displayed
          on the bar.

     ...: Optional graphical parameters, see 'par'.

_A_u_t_h_o_r(_s):

     Sandrine Dudoit, Yee Hwa (Jean) Yang.

_S_e_e _A_l_s_o:

     'image', 'arrayPlot' 'myPalette'.

_E_x_a_m_p_l_e_s:

     par(mfrow=c(3,1))
     Rcol <- myPalette(low="white", high="red", k=10)
     Gcol <- myPalette(low="white", high="green", k=50)
     RGcol <- myPalette(low="green", high="red", k=100)
     ColorBar(Rcol)
     ColorBar(Gcol, scale=c(-5,5))
     ColorBar(1:50, col=RGcol)

     par(mfrow=c(1,3))
     x<-seq(-1, 1, by=0.01)
     ColorBar(x, col=Gcol, horizontal=FALSE, k=11)
     ColorBar(x, col=Gcol, horizontal=FALSE, k=21)
     ColorBar(x, col=Gcol, horizontal=FALSE, k=51)

