summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--R/estpoly.R9
-rw-r--r--man/residplot.Rd20
2 files changed, 29 insertions, 0 deletions
diff --git a/R/estpoly.R b/R/estpoly.R
index c47d1ff..a2bf7de 100644
--- a/R/estpoly.R
+++ b/R/estpoly.R
@@ -94,6 +94,15 @@ plot.estpoly <- function(model,newdata=NULL){
geom_abline(intercept=0,slope=1,colour="#D55E00") + geom_point()
}
+#' Plot residual characteristics
+#'
+#' Computes the 1-step ahead prediction errors (residuals) for an estimated polynomial
+#' model, and plots auto-correlation of the residuals and the
+#' cross-correlation of the residuals with the input signals.
+#'
+#' @param model estimated polynomial model
+#' @param newdata an optional dataset on which predictions are to be computed. If
+#' not supplied, predictions are computed on the training dataset.
#' @export
residplot <- function(model,newdata=NULL){
if(is.null(newdata)){
diff --git a/man/residplot.Rd b/man/residplot.Rd
new file mode 100644
index 0000000..b9509c9
--- /dev/null
+++ b/man/residplot.Rd
@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/estpoly.R
+\name{residplot}
+\alias{residplot}
+\title{Plot residual characteristics}
+\usage{
+residplot(model, newdata = NULL)
+}
+\arguments{
+\item{model}{estimated polynomial model}
+
+\item{newdata}{an optional dataset on which predictions are to be computed. If
+not supplied, predictions are computed on the training dataset.}
+}
+\description{
+Computes the 1-step ahead prediction errors (residuals) for an estimated polynomial
+model, and plots auto-correlation of the residuals and the
+cross-correlation of the residuals with the input signals.
+}
+