summaryrefslogtreecommitdiff
path: root/R
diff options
context:
space:
mode:
authorSuraj Yerramilli2015-12-29 19:13:20 +0530
committerSuraj Yerramilli2015-12-29 19:13:20 +0530
commita4ecb14f8ee3818ab9acdb6f10efc99e103e14c2 (patch)
tree5e9f12715cb933b624ecd3a28053faa4a5877811 /R
parent1d068248248b09591f6612b3db17949314c73bda (diff)
downloadSysID-R-code-a4ecb14f8ee3818ab9acdb6f10efc99e103e14c2.tar.gz
SysID-R-code-a4ecb14f8ee3818ab9acdb6f10efc99e103e14c2.tar.bz2
SysID-R-code-a4ecb14f8ee3818ab9acdb6f10efc99e103e14c2.zip
updated oe documentation
Diffstat (limited to 'R')
-rw-r--r--R/estpoly.R24
1 files changed, 17 insertions, 7 deletions
diff --git a/R/estpoly.R b/R/estpoly.R
index 47cd97e..b016d82 100644
--- a/R/estpoly.R
+++ b/R/estpoly.R
@@ -310,16 +310,26 @@ armax <- function(x,order=c(0,1,1,0),options=optimOptions()){
#' An object of class \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} \tab the residual degrees of freedom \cr
+#' \code{sys} \tab an \code{idpoly} object containing the
+#' fitted OE coefficients \cr
#' \code{fitted.values} \tab the predicted response \cr
#' \code{residuals} \tab the residuals \cr
+#' \code{input} \tab the input data used \cr
#' \code{call} \tab the matched call \cr
-#' \code{time} \tab the time of the data used \cr
-#' \code{input} \tab the input data used
+#' \code{stats} \tab A list containing the following fields:
+#' \tabular{ll}{
+#' \code{vcov} \tab the covariance matrix of the fitted coefficients\cr
+#' \code{sigma} \tab the standard deviation of the innovations
+#' } \cr
+#' \code{options} \tab Option set used for estimation. If no
+#' custom options were configured, this is a set of default options. \cr
+#' \code{termination} \tab Termination conditions for the iterative
+#' search used for prediction error minimization.
+#' \tabular{ll}{
+#' \code{WhyStop} \tab Reason for termination \cr
+#' \code{iter} \tab Number of Iterations \cr
+#' \code{iter} \tab Number of Function Evaluations
+#' }
#' }
#'
#'