File: UnitrootTests.Rd

package info (click to toggle)
funitroots 4052.82-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,788 kB
  • sloc: fortran: 509; ansic: 16; makefile: 14
file content (154 lines) | stat: -rw-r--r-- 4,079 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
\name{UnitrootTests}
\alias{UnitrootTests}

\alias{unitrootTest}
\alias{adfTest}

\concept{unit root tests}
\concept{Dickey-Fuller test}
\concept{augmented Dickey-Fuller test}
\concept{MacKinnon's unit root test}


\title{Unit root time series tests}

\description{
  Carry out augmented Dickey-Fuller tests for unit roots based on
  Banerjee's et al. tables and on J.G. McKinnons' numerical distribution
  functions.
}

\usage{
unitrootTest(x, lags = 1, type = c("nc", "c", "ct"), title = NULL, 
    description = NULL)
    
adfTest(x, lags = 1, type = c("nc", "c", "ct"), title = NULL, 
    description = NULL)
}

\arguments{
  \item{x}{
    a numeric vector or time series object.
  }  
  \item{lags}{
    the maximum number of lags used for error term correction.
  }
  \item{type}{    
    a character string describing the type of the unit root
    regression. Valid choices are \code{"nc"} for a regression with no
    intercept (constant) nor time trend, \code{"c"} for a regression
    with an intercept (constant) but no time trend, \code{"ct"} for a
    regression with an intercept (constant) and a time trend. The
    default is \code{"c"}.
  }
  \item{title}{
    a character string which allows for a project title.
  }
  \item{description}{
    a character string which allows for a brief description.
  }
}

\details{
    \code{adfTest()} computes test statistics and p-values along the
    implementation from Trapletti's augmented Dickey-Fuller test for
    unit roots. In contrast to Trapletti's function, three kind of test
    types can be selected.
    
    \code{unitrootTest()} computes test statistics and p-values using
    McKinnon's response surface approach.
}

\value{

    an object from S4 class \code{"fHTEST"} with the following slots:

    \item{@call}{
      the function call.      
    }
    \item{@data}{
      a data frame with the input data.
    }
    \item{@data.name}{
      a character string giving the name of the data frame.
    }
    \item{@test}{
      a list object which holds the output of the underlying test
      function.
    }
    \item{@title}{
      a character string with the name of the test.
    }
    \item{@description}{
      a character string with a brief description of the test.
    }
        
    The entries of the \code{@test} slot include the following components:

    \item{$statistic}{
      the value of the test statistic.
    }
    \item{$parameter}{
      the lag order.
    }
    \item{$p.value}{
      the p-value of the test.
    }
    \item{$method}{
      a character string indicating what type of test was performed.
    } 
    \item{$data.name}{
      a character string giving the name of the data.
    }
    \item{$alternative}{
      a character string describing the alternative hypothesis.
    }
    \item{$name}{
      the name of the underlying function, which may be wrapped.
    }
    \item{$output}{
      additional test results to be printed.
    }
}

\references{
Banerjee A., Dolado J.J., Galbraith J.W., Hendry D.F. (1993);
    \emph{Cointegration, Error Correction, and the Econometric 
        Analysis of Non-Stationary Data},
    Oxford University Press, Oxford. 
    
Dickey, D.A., Fuller, W.A. (1979);
    \emph{Distribution of the estimators for autoregressive time 
        series with a unit root}, 
    Journal of the American Statistical Association 74, 427--431. 
    
MacKinnon, J.G. (1996);
    \emph{Numerical distribution functions for unit root and 
        cointegration tests},
    Journal of Applied Econometrics 11, 601--618.
    
Said S.E., Dickey D.A. (1984);
    \emph{Testing for Unit Roots in Autoregressive-Moving Average 
        Models of Unknown Order},
    Biometrika 71, 599--607.
}

\author{
  Adrian Trapletti for the tests adapted from R's "tseries" package, \cr
  Diethelm Wuertz for the Rmetrics \R-port.
}

\examples{
## a time series which contains no unit-root:
x <- rnorm(1000)  
## a time series which contains a unit-root:
y <- cumsum(c(0, x))
   
adfTest(x)
adfTest(y)
   
unitrootTest(x)
unitrootTest(y)     
}

\keyword{htest}