grid.frame               package:grid               R Documentation

_C_r_e_a_t_e _a _F_r_a_m_e _f_o_r _P_a_c_k_i_n_g _O_b_j_e_c_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     These functions, together with 'grid.pack', 'grid.place',
     'packGrob', and 'placeGrob' are part of a GUI-builder-like
     interface to constructing graphical images. The idea is that you
     create a frame with this function then use 'grid.pack' or whatever
     to pack/place objects into the frame.

_U_s_a_g_e:

     grid.frame(layout=NULL, name=NULL, gp=gpar(), vp=NULL, draw=TRUE)
     frameGrob(layout=NULL, name=NULL, gp=gpar(), vp=NULL)

_A_r_g_u_m_e_n_t_s:

  layout: A Grid layout, or NULL. This can be used to initialise the
          frame with a number of rows and columns, with initial widths
          and heights, etc. 

    name: A character identifier. 

      vp: An object of class 'viewport', or NULL. 

      gp: An object of class 'gpar';  typically the output from a call
          to the function 'gpar'.

    draw: Should the frame be drawn.  

_D_e_t_a_i_l_s:

     Both functions create a frame grob (a graphical object describing
     a frame), but only 'grid.frame()' draws the frame (and then only
     if 'draw' is 'TRUE'). Nothing will actually be drawn, but it will
     put the frame on the display list, which means that the output
     will be dynamically updated as objects are packed into the frame. 
     Possibly useful for debugging.

_V_a_l_u_e:

     A frame grob.  'grid.frame()' returns the value invisibly.

_A_u_t_h_o_r(_s):

     Paul Murrell

_S_e_e _A_l_s_o:

     'grid.pack'

_E_x_a_m_p_l_e_s:

     grid.newpage()
     grid.frame(name="gf", draw=TRUE)
     grid.pack("gf", rectGrob(gp=gpar(fill="grey")), width=unit(1, "null"))
     grid.pack("gf", textGrob("hi there"), side="right")

