comment                 package:base                 R Documentation

Query or Set a 'Comment' Attribute

Description:

     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.

Usage:

     comment(x)
     comment(x) <- value

Arguments:

       x: any R object

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

See Also:

     'attributes' and 'attr' for other attributes.

Examples:

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

