diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/dataSlice.Rd | 2 | ||||
| -rw-r--r-- | man/detrend.Rd | 2 | ||||
| -rw-r--r-- | man/idframe.Rd | 2 | ||||
| -rw-r--r-- | man/impulseest.Rd | 30 | ||||
| -rw-r--r-- | man/plot.idframe.Rd | 2 | ||||
| -rw-r--r-- | man/plot.impulseest.Rd (renamed from man/impulse.Rd) | 8 | ||||
| -rw-r--r-- | man/predict.detrend.Rd | 2 | ||||
| -rw-r--r-- | man/read.idframe.Rd | 2 | ||||
| -rw-r--r-- | man/read.table.idframe.Rd | 2 | ||||
| -rw-r--r-- | man/read.xls.idframe.Rd | 2 | ||||
| -rw-r--r-- | man/step.Rd | 4 | ||||
| -rw-r--r-- | man/summary.idframe.Rd | 2 | ||||
| -rw-r--r-- | man/tf.Rd | 2 |
13 files changed, 23 insertions, 39 deletions
diff --git a/man/dataSlice.Rd b/man/dataSlice.Rd index 9b5567e..9fd571e 100644 --- a/man/dataSlice.Rd +++ b/man/dataSlice.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/partition.R \name{dataSlice} \alias{dataSlice} diff --git a/man/detrend.Rd b/man/detrend.Rd index b63d3a0..83b208b 100644 --- a/man/detrend.Rd +++ b/man/detrend.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/detrend.R \name{detrend} \alias{detrend} diff --git a/man/idframe.Rd b/man/idframe.Rd index 29276bf..3b3ba0b 100644 --- a/man/idframe.Rd +++ b/man/idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/idframe.R \name{idframe} \alias{idframe} diff --git a/man/impulseest.Rd b/man/impulseest.Rd index 99c9e37..c831cc3 100644 --- a/man/impulseest.Rd +++ b/man/impulseest.Rd @@ -1,39 +1,23 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/impulse.R \name{impulseest} \alias{impulseest} \title{Estimate Impulse Response Models} \usage{ -impulseest(data, lags = 30, conf = 0.95) +impulseest(data, M = 30, K) } \arguments{ \item{data}{an object of class \code{idframe}} -\item{lags}{The number of lags upto which the estimate is to be -calculated. (Default:\code{30})} +\item{M}{Order of the FIR Model (Default:\code{30})} -\item{conf}{The confidence interval} -} -\value{ -An object of class \code{impulseest} containing the following elements -\tabular{ll}{ - \code{coefs} \tab \code{list} containing the impulse response coefficients \cr - \code{lower} \tab \code{list} containing the lower confidence bounds of the - impulse response coefficients \cr - \code{upper} \tab \code{list} containing the upper confidence bounds of the - impulse response coefficients \cr -} +\item{K}{Transport delay in the estimated impulse response} } \description{ -\code{impulseest} is used to estimate impulse response models given data -} -\details{ -This function extends the \code{\link[vars]{irf}} function, which estimates the -impulse response coefficients given a VAR model for the data. The VAR model is fit -using the \code{\link[vars]{VAR}} function. +\code{impulseest} is used to estimate impulse response models in the +given data } \seealso{ -\code{\link[vars]{irf}}, \code{\link[vars]{VAR}}, \code{\link{impulse}} , -\code{\link{step}} +\code{\link{plot.impulseest}}, \code{\link{step}} } diff --git a/man/plot.idframe.Rd b/man/plot.idframe.Rd index 86e2600..8683d70 100644 --- a/man/plot.idframe.Rd +++ b/man/plot.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/idframe.R \name{plot.idframe} \alias{plot.idframe} diff --git a/man/impulse.Rd b/man/plot.impulseest.Rd index 2870f15..910f53e 100644 --- a/man/impulse.Rd +++ b/man/plot.impulseest.Rd @@ -1,10 +1,10 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/impulse.R -\name{impulse} -\alias{impulse} +\name{plot.impulseest} +\alias{plot.impulseest} \title{Impulse Response Plots} \usage{ -impulse(model) +\method{plot}{impulseest}(model) } \arguments{ \item{model}{an object of class \code{impulseest}} diff --git a/man/predict.detrend.Rd b/man/predict.detrend.Rd index 41667c7..4cfdd70 100644 --- a/man/predict.detrend.Rd +++ b/man/predict.detrend.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/detrend.R \name{predict.detrend} \alias{predict.detrend} diff --git a/man/read.idframe.Rd b/man/read.idframe.Rd index 24546df..b3906c4 100644 --- a/man/read.idframe.Rd +++ b/man/read.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/readData.R \name{read.idframe} \alias{read.idframe} diff --git a/man/read.table.idframe.Rd b/man/read.table.idframe.Rd index f8db672..d3b5605 100644 --- a/man/read.table.idframe.Rd +++ b/man/read.table.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/readData.R \name{read.table.idframe} \alias{read.table.idframe} diff --git a/man/read.xls.idframe.Rd b/man/read.xls.idframe.Rd index c33a703..f4ba64c 100644 --- a/man/read.xls.idframe.Rd +++ b/man/read.xls.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/readData.R \name{read.xls.idframe} \alias{read.xls.idframe} diff --git a/man/step.Rd b/man/step.Rd index dfa014c..e7d69bc 100644 --- a/man/step.Rd +++ b/man/step.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/impulse.R \name{step} \alias{step} @@ -13,6 +13,6 @@ step(model) Plots the step response of a system, given the IR model } \seealso{ -\code{\link{impulseest}},\code{\link{impulse}} +\code{\link{impulseest}} } diff --git a/man/summary.idframe.Rd b/man/summary.idframe.Rd index e28372b..dfa0841 100644 --- a/man/summary.idframe.Rd +++ b/man/summary.idframe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/idframe.R \name{summary.idframe} \alias{summary.idframe} @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand +% Generated by roxygen2 (4.1.1): do not edit by hand % Please edit documentation in R/tf.R \name{tf} \alias{tf} |