File: timeSeries-slotUnits.Rd

package info (click to toggle)
r-cran-timeseries 4041.111-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,704 kB
  • sloc: makefile: 14
file content (50 lines) | stat: -rw-r--r-- 761 bytes parent folder | download
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
49
50
\name{units}

\alias{getUnits}
\alias{getUnits.default}

\alias{setUnits<-}


\title{Get and set unit names of a 'timeSeries'}

\description{

  Gets and sets the column names of a \code{"timeSeries"} object. The
  column names are also called units or unit names.
    
}

\usage{
getUnits(x)         
setUnits(x) <- value
}

\arguments{

  \item{x}{
    a \code{"timeSeries"} object.
  }
  \item{value}{
    a character vector of unit names.
  }
}

\seealso{
  \code{\link{timeSeries}}
}

\examples{
## A Dummy 'timeSeries' Object
   tS <- dummyMonthlySeries()
   tS

## Get the Units - 
   getUnits(tS)

## Assign New Units to the Series - 
   setUnits(tS) <- c("A", "B")
   head(tS)
}

\keyword{programming}