

comment {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').

_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

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

     `attributes' and `attr' for ``normal'' 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)

