BivariateBinning          package:fMultivar          R Documentation

_S_q_u_a_r_e _a_n_d _H_e_x_a_g_o_n_a_l _D_a_t_a _B_i_n_n_i_n_g

_D_e_s_c_r_i_p_t_i_o_n:

     A collection and description of functions which allow to create
     histograms due to sqaure and hexagonal binning. 

     Bivariate Binning Functions:

       'squareBinning'  does a square binning of data points,
       'hexBinning'     does a hexagonal binning of data points

_U_s_a_g_e:

      
     squareBinning(x, y = NULL, bins = 30)
     hexBinning(x, y = NULL, bins = 30)

     ## S3 method for class 'squareBinning':
     plot(x, col = heat.colors(12), addPoints = TRUE, 
         addRug = TRUE, ...)
     ## S3 method for class 'hexBinning':
     plot(x, col = heat.colors(12), addPoints = TRUE, 
         addRug = TRUE, ...)

_A_r_g_u_m_e_n_t_s:

addPoints: a logical flag, should the center of mass points added to
          the plot? 

  addRug: a logical flag, should a rug representation be added to the
          plot, for details see the function 'rug'. 

    bins: an integer specifying the number of bins. 

     col: color map like for the 'image' function. 

    x, y: [squareBinning][hexBinning] - 
           either two numeric vectors of equal length or if  'y'  is
          NULL, a list with entries 'x', 'y',  or named data frame with
          'x' in the first and 'y' in the second column. Note,
          'timeSeries' objects are also allowed as input.
           [plot] - 
           an object of class 'squareBinning' or 'hexBinning'. 

     ...: arguments to be passed. 

_V_a_l_u_e:

     A list with three entries, 'x', 'y' and 'z', specified by an oject
     of class 'squareBinning' or  'hexBinning'.

     Note, the returned value, can be directly used by the 'persp()' 
     and 'contour' 3D plotting functions.

_A_u_t_h_o_r(_s):

     Diethelm Wuertz for the Rmetrics R-port.

_E_x_a_m_p_l_e_s:

     ## squareBinning -
        sB = squareBinning(x = rnorm(1000), y = rnorm(1000))
        plot(sB)
        
     ## hexBinning -
        hB = hexBinning(x = rnorm(1000), y = rnorm(1000))
        plot(hB)

