From db747b5554e3f5c7adb79fd6964453acb64e628e Mon Sep 17 00:00:00 2001
From: Suraj Yerramilli
Date: Sat, 6 Jun 2015 17:03:13 +0530
Subject: Added return value in documentation

---
 R/estpoly.R | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'R')

diff --git a/R/estpoly.R b/R/estpoly.R
index 96c258e..68bfb67 100644
--- a/R/estpoly.R
+++ b/R/estpoly.R
@@ -32,9 +32,21 @@ plot.estPoly <- function(model,newdata=NULL){
 #' ARX models are of the form \\
 #' 
 #' @return
-#' An object having classes \code{estARX} and \code{estPoly} containing 
+#' An object with classes \code{estARX} and \code{estPoly}, containing 
 #' the following elements:
 #' 
+#' \tabular{ll}{
+#'    \code{coefficients} \tab an \code{idpoly} object containing the 
+#'    fitted coefficients \cr
+#'    \code{vcov} \tab the covariance matrix of the fitted coefficients\cr
+#'    \code{sigma} \tab the standard deviation of the innovations\cr
+#'    \code{df} the residual degrees of freedom\tab \cr
+#'    \code{fitted.values} \tab the predicted response
+#'    \code{residuals} \tab the residuals  \cr
+#'    \code{call} \tab the matched call \cr
+#'    \code{time} \tab the time of the data used \cr
+#'  }
+#' 
 #' 
 #' @references
 #' Arun K. Tangirala (2015), Principles of System Identification: Theory and 
-- 
cgit