summaryrefslogtreecommitdiff
path: root/R/impulse.R
diff options
context:
space:
mode:
authorSuraj Yerramilli2015-03-23 00:23:16 +0530
committerSuraj Yerramilli2015-03-23 00:23:16 +0530
commit4052c08aca7ad8528d04e9ed17e25b1cb910f399 (patch)
tree3cf06683427bedf75e7bba97282d4f2eb99ec633 /R/impulse.R
parente1cc3dd25ff07f9eead3c40a24ffa29466232dff (diff)
downloadSysID-R-code-4052c08aca7ad8528d04e9ed17e25b1cb910f399.tar.gz
SysID-R-code-4052c08aca7ad8528d04e9ed17e25b1cb910f399.tar.bz2
SysID-R-code-4052c08aca7ad8528d04e9ed17e25b1cb910f399.zip
Added raw documentation for the impulse and step response plots
Diffstat (limited to 'R/impulse.R')
-rw-r--r--R/impulse.R18
1 files changed, 16 insertions, 2 deletions
diff --git a/R/impulse.R b/R/impulse.R
index d248f88..ede7684 100644
--- a/R/impulse.R
+++ b/R/impulse.R
@@ -38,13 +38,27 @@ impulseest <- function(data,lags=30,conf=0.95){
return(out)
}
-# Impulse Response Plots
+#' Impulse Response Plots
+#'
+#' Plots the estimated IR Coefficients
+#'
+#' @param model an object of class \code{impulseest}
+#'
+#' @seealso \code{\link{impulseest}},\code{\link{step}}
+#' @export
impulse <- function(model){
}
-# Step Response Plots
+#' Step Response Plots
+#'
+#' Plots the step response of a system, given the IR model
+#'
+#' @param model an object of class \code{impulseest}
+#'
+#' @seealso \code{\link{impulseest}},\code{\link{impulse}}
+#' @export
step <- function(model){
}