diff options
| -rw-r--r-- | R/impulse.R | 18 | ||||
| -rw-r--r-- | man/impulse.Rd | 18 | ||||
| -rw-r--r-- | man/step.Rd | 18 |
3 files changed, 52 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){ } diff --git a/man/impulse.Rd b/man/impulse.Rd new file mode 100644 index 0000000..2870f15 --- /dev/null +++ b/man/impulse.Rd @@ -0,0 +1,18 @@ +% 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/step.Rd b/man/step.Rd new file mode 100644 index 0000000..dfa014c --- /dev/null +++ b/man/step.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2 (4.1.0): do not edit by hand +% Please edit documentation in R/impulse.R +\name{step} +\alias{step} +\title{Step Response Plots} +\usage{ +step(model) +} +\arguments{ +\item{model}{an object of class \code{impulseest}} +} +\description{ +Plots the step response of a system, given the IR model +} +\seealso{ +\code{\link{impulseest}},\code{\link{impulse}} +} + |