formatClassSlots         package:RGtkViewers         R Documentation

_C_r_e_a_t_e _H_T_M_L _d_e_s_c_r_i_b_i_n_g _s_l_o_t_s _f_o_r _a_n _S_4 _c_l_a_s_s

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

     This creates HTML content describing the slots defined for an S4
     class.

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

     formatClassSlots(slots, className)

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

   slots: either a named list containing the character vectors for the
          slots defined by the classes given in the names attribute, or
          a simple named character vector giving the slot types and
          indexed by the names of the slots (as the 'names()'
          attribute).

className: the name of the S4 class being documented.

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

     A character vector of length 1 giving the generated HTML content.

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

     Duncan Temple Lang <duncan@research.bell-labs.com>

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://www.omegahat.org/RGtk>, <URL: http://www.gtk.org>

_S_e_e _A_l_s_o:

     'S4ClassView'

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

