\Header{comment}{Query or Set a `Comment' Attribute}
\alias{comment$\leftarrow $}{comment}
\keyword{attribute}{comment}
\begin{Usage}
\begin{verbatim}
comment(x)
comment(x) <- value
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\texttt{x}] any \R\ object
\item[\texttt{value}] a \texttt{character} vector
\end{ldescription}
\end{Arguments}
\begin{Description}
These functions set and query a \emph{comment}
attribute for any \R\ objects.  This is typically useful for
\texttt{\Link{data.frame}}s or model fits.

Contrary to other \texttt{\Link{attributes}}, the \texttt{comment} is not
printed (by \texttt{\Link{print}} or \texttt{\Link{print.default}}).\end{Description}
\begin{SeeAlso}
\texttt{\Link{attributes}} and \texttt{\Link{attr}} for ``normal'' attributes.\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
x <- matrix(1:12, 3,4)
comment(x) <- c("This is my very important data from experiment #0234",
                "Jun 5, 1998")
x
comment(x)
\end{ExampleCode}
\end{Examples}

