comment                 package:base                 R Documentation

_Q_u_e_r_y _o_r _S_e_t _a '_C_o_m_m_e_n_t' _A_t_t_r_i_b_u_t_e

_D_e_s_c_r_i_p_t_i_o_n:

     These functions set and query a _comment_ attribute for any R
     objects.  This is typically useful for 'data.frame's or model
     fits.

     Contrary to other 'attributes', the 'comment' is not printed (by
     'print' or 'print.default').

     Assigning 'NULL' or a zero-length character vector removes the
     comment.

_U_s_a_g_e:

     comment(x)
     comment(x) <- value

_A_r_g_u_m_e_n_t_s:

       x: any R object

   value: a 'character' vector, or 'NULL'.

_S_e_e _A_l_s_o:

     'attributes' and 'attr' for other attributes.

_E_x_a_m_p_l_e_s:

     x <- matrix(1:12, 3,4)
     comment(x) <- c("This is my very important data from experiment #0234",
                     "Jun 5, 1998")
     x
     comment(x)