1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
\name{comment}
\alias{comment}
\alias{comment<-}
\alias{comment,timeSeries-method}
\alias{comment<-,timeSeries-method}
\title{Get and set comments for 'timeSeries' objects}
\description{
Get or assign new comment to a \code{timeSeries} object.
}
\usage{
\S4method{comment}{timeSeries}(x)
\S4method{comment}{timeSeries}(x) <- value
}
\arguments{
\item{x}{
a \code{timeSeries} object.
}
\item{value}{
a character vector, the comment.
}
}
\details{
Objects from class \code{"timeSeries"} have a slot for documentation.
These functions get and change its contents.
}
\examples{
## Get description from a 'timeSeries' -
comment(LPP2005REC)
## Add User to comment -
comment(LPP2005REC) <- paste(comment(LPP2005REC), "by User Rmetrics")
comment(LPP2005REC)
}
\keyword{chron}
|
