timeSeries (version 4041.111)

comment: Get and set comments for 'timeSeries' objects

Description

Get or assign new comment to a timeSeries object.

Usage

# S4 method for timeSeries
comment(x)
# S4 method for timeSeries
comment(x) <- value

Arguments

x

a timeSeries object.

value

a character vector, the comment.

Details

Objects from class "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)