File: timeSeries-isUnivariate.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 (54 lines) | stat: -rw-r--r-- 946 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
51
52
53
54
\name{isUnivariate}
\alias{isUnivariate}
\alias{isMultivariate}


\title{Checks if a time series is univariate}

\description{
    
  Checks if a time series object or any other rectangular object is
  univariate or multivariate.

}

\usage{
isUnivariate(x)
isMultivariate(x)
}

\arguments{
  \item{x}{ 
    an object of class \code{"timeSeries"} or any other rectangular
    object.
  }
}

\details{

  A rectangular object \code{x} is considered to be univariate if the
  function \code{NCOL(x)} returns one, and is considered to be
  multivariate if \code{NCOL(x)} returns a value bigger than one.

}

\value{
  a logical value
}

\examples{
## Load Microsoft Data - 
   setRmetricsOptions(myFinCenter = "GMT")
   data(MSFT)
   Open = MSFT[, "Open"]
  
## Is the 'timeSeries' Univariate - 
   isUnivariate(MSFT)
   isUnivariate(Open)

## Is the 'timeSeries' Multivariate -   
   isMultivariate(MSFT)
   isMultivariate(Open)
}

\keyword{chron}