File: utils-structure.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 (46 lines) | stat: -rw-r--r-- 770 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
\name{str-methods}
\alias{str-methods}
\alias{str}
\alias{str.timeSeries}


\title{Display the structure of 'timeSeries' objects}

\description{
    
  Compactly display the structure of a \code{"timeSeries"} object.        
    
}

\usage{
\method{str}{timeSeries}(object, \dots)
}

\arguments{
  \item{object}{  
    an object of class \code{timeSeries}.
  }
  \item{\dots}{
    arguments passed to other methods.
  }
}

\value{

  \code{NULL}, invisibly. The function is called for its side effect of
  printing a compact representation of the structure of the
  \code{"timeSeries"} object.
        
}

\examples{
## Load Microsoft Data Set
data(MSFT)
X <- MSFT[1:12, 1:4]
colnames(X) <- abbreviate(colnames(X), 4)
    
## Display Structure
str(X)
}

\keyword{chron}