From 177dd0536ea9da096aab481a18914c97cee925a0 Mon Sep 17 00:00:00 2001
From: Suraj Yerramilli
Date: Mon, 25 May 2015 14:39:51 +0530
Subject: Update in documentation

---
 NAMESPACE                 |  4 ++--
 R/impulse.R               |  4 ++--
 man/dataSlice.Rd          |  2 +-
 man/detrend.Rd            |  2 +-
 man/idframe.Rd            |  2 +-
 man/impulse.Rd            | 18 ------------------
 man/impulseest.Rd         | 30 +++++++-----------------------
 man/plot.idframe.Rd       |  2 +-
 man/plot.impulseest.Rd    | 18 ++++++++++++++++++
 man/predict.detrend.Rd    |  2 +-
 man/read.idframe.Rd       |  2 +-
 man/read.table.idframe.Rd |  2 +-
 man/read.xls.idframe.Rd   |  2 +-
 man/step.Rd               |  4 ++--
 man/summary.idframe.Rd    |  2 +-
 man/tf.Rd                 |  2 +-
 16 files changed, 41 insertions(+), 57 deletions(-)
 delete mode 100644 man/impulse.Rd
 create mode 100644 man/plot.impulseest.Rd

diff --git a/NAMESPACE b/NAMESPACE
index 1092d93..89d5843 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,13 +1,13 @@
-# Generated by roxygen2 (4.1.0): do not edit by hand
+# Generated by roxygen2 (4.1.1): do not edit by hand
 
 S3method(plot,idframe)
+S3method(plot,impulseest)
 S3method(predict,detrend)
 S3method(print,tf)
 S3method(summary,idframe)
 export(dataSlice)
 export(detrend)
 export(idframe)
-export(impulse)
 export(impulseest)
 export(read.idframe)
 export(read.table.idframe)
diff --git a/R/impulse.R b/R/impulse.R
index 7ff9b34..2066c4f 100644
--- a/R/impulse.R
+++ b/R/impulse.R
@@ -45,8 +45,8 @@ plot.impulseest <- function(model){
 #' 
 #' @param model an object of class \code{impulseest}
 #' 
-#' @seealso \code{\link{impulseest}},\code{\link{impulse}}
+#' @seealso \code{\link{impulseest}}
 #' @export 
 step <- function(model){
-  
+    
 }
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/impulse.Rd b/man/impulse.Rd
deleted file mode 100644
index 2870f15..0000000
--- a/man/impulse.Rd
+++ /dev/null
@@ -1,18 +0,0 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/impulse.R
-\name{impulse}
-\alias{impulse}
-\title{Impulse Response Plots}
-\usage{
-impulse(model)
-}
-\arguments{
-\item{model}{an object of class \code{impulseest}}
-}
-\description{
-Plots the estimated IR Coefficients
-}
-\seealso{
-\code{\link{impulseest}},\code{\link{step}}
-}
-
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/plot.impulseest.Rd b/man/plot.impulseest.Rd
new file mode 100644
index 0000000..910f53e
--- /dev/null
+++ b/man/plot.impulseest.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/impulse.R
+\name{plot.impulseest}
+\alias{plot.impulseest}
+\title{Impulse Response Plots}
+\usage{
+\method{plot}{impulseest}(model)
+}
+\arguments{
+\item{model}{an object of class \code{impulseest}}
+}
+\description{
+Plots the estimated IR Coefficients
+}
+\seealso{
+\code{\link{impulseest}},\code{\link{step}}
+}
+
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}
diff --git a/man/tf.Rd b/man/tf.Rd
index b0055b5..3cfc35c 100644
--- a/man/tf.Rd
+++ b/man/tf.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/tf.R
 \name{tf}
 \alias{tf}
-- 
cgit