summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--R/estpoly.R14
-rw-r--r--man/estARX.Rd14
2 files changed, 26 insertions, 2 deletions
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
diff --git a/man/estARX.Rd b/man/estARX.Rd
index 28f0b82..d4ff9b6 100644
--- a/man/estARX.Rd
+++ b/man/estARX.Rd
@@ -14,8 +14,20 @@ estARX(data, order = c(0, 1, 0))
the input-output delay}
}
\value{
-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
+ }
}
\description{
Fit an ARX model of the specified order given the input-output data